Phase

Computes the phase of elements of a complex data image.

Syntax

IppStatus ippiPhase_<mod>(const Ipp<srcDatatype>* pSrc, int srcStep, Ipp<dstDatatype>* pDst, int dstStep, IppiSize roiSize);

Supported values for mod:

32fc32f_C1R

32fc32f_C3R

IppStatus ippiPhase_<mod>(const Ipp<srcDatatype>* pSrc, int srcStep, Ipp<dstDatatype>* pDst, int dstStep, IppiSize roiSize, int scaleFactor);

Supported values for mod:

16uc16u_C1RSfs	16uc16u_C3RSfs
16sc16s_C1RSfs	16sc16s_C3RSfs
32sc32s_C1RSfs	32sc32s_C3RSfs

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.
roiSize	Size of the source and destination ROI in pixels.
scaleFactor	Scale factor (see Integer Result Scaling).

Description

The function ippiPhase is declared in the ippi.h file. It operates with ROI (see Regions of Interest in Intel IPP).

This function computes the phase in radians of elements of a source image pSrc given in complex data 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 condition if pSrc or pDst pointer is `NULL`.
ippStsStepErr	Indicates an error condition if srcStep or dstStep value is zero or negative.
ippStsSizeErr	Indicates an error condition if width or height of images is less than or equal to zero.