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

PyramidLayerUp

Creates an upper pyramid layer.

Syntax

IppStatus ippiPyramidLayerUp_<mod>(const Ipp<datatype>* pSrc, int srcStep, IppiSize srcRoiSize, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiPyramidUpState_<mod>* pState);

Supported values for mod:

8u_C1R

16u_C1R

32f_C1R

8u_C3R

16u_C3R

32f_C3R

Platform-aware functions

IppStatus ippiPyramidLayerUp_32f_C1R_L(const Ipp32f* pSrc, IppiSizeL srcStep, IppiSizeL srcRoiSize, Ipp32f* pDst, IppiSizeL dstStep, IppiSizeL dstRoiSize, IppiPyramidUpState_32f_C1R_L* pState);

Include Files

ippcv.h

Flavors with the _L suffix: ippcv_l.h

Domain Dependencies

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

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

Parameters

pSrc
Pointer to the source image ROI.
srcStep
Distance, in bytes, between the starting points of consecutive lines in the source image.
srcRoiSize
Size of source image ROI, in pixels.
pDst
Pointer to the destination image ROI.
dstStep
Distance, in bytes, between the starting points of consecutive lines in the destination image.
dstRoiSize
Size of destination image ROI, in pixels.
pState
The pointer to the pyramid layer structure.

Description

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

This function creates an upper pyramid layer pDst from the source image pSrc. The function performs upsampling of the source image and then applies the convolution kernel using the mirror border. Before calling the ippiPyramidLayerUp function, compute the size of the pyramid layer structure pState using the PyramidLayerUpGetSize function and initialize the structure using the PyramidLayerUpInit function. The function can process images with srcRoiSize not greater than the roiSize parameter specified in the PyramidLayerUpInit function.

NOTE:

This function uses the mirrored border.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error if one of the specified pointers is NULL.

ippStsSizeErr

Indicates an error condition if srcRoiSize or dstRoiSize has a field with zero or negative value.

ippStsStepErr

Indicates an error condition if srcStep is less than srcRoiSize.width * <pixelSize> , or dstStep is less than dstRoiSize.width * <pixelSize>.

ippStsNotEvenStepErr

Indicates an error condition if one of the step values is not divisible by 4 for floating-point images, or by 2 for short-integer images.

ippStsBadArgErr

Indicates an error condition if pState->rate has wrong value.

See Also