Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

MagnitudePack

MODIFIED API. Computes magnitude of elements of an image in packed format.

Syntax

IppStatus ippiMagnitudePack_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, Ipp8u* pBuffer);

Supported values for mod:

32f_C1R

32f_C3R

Include Files

ippi.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib

Parameters

pSrc

Pointer to the source image ROI.

srcStep

Distance in bytes between starts of consecutive lines in the source image.

pDst

Pointer to the destination image ROI.

dstStep

Distance in bytes between starts of consecutive lines in the destination image.

dstRoiSize

Size of the destination ROI in pixels.

pBuffer

Pointer to the work buffer. To compute the size of the buffer, use the ippiMagnitudePackGetBufferSize function.

Description

IMPORTANT:
The API of this function has been modified in Intel IPP 9.0 release.

This function operates with ROI (see Regions of Interest in Intel IPP).

This function computes magnitude of elements of the source image pSrc given in RCPack2D format and stores results in the destination image pDst.

Return Values

ippStsNoErr

Indicates no error. Any other value indicates an error or a warning.

ippStsNullPtrErr

Indicates an error when pSrc or pDst pointer is NULL.

ippStsStepErr

Indicates an error when srcStep or dstStep value is zero or negative.

ippStsSizeErr

Indicates an error when width or height of images is less than, or equal to zero.

See Also