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

GetPyramidUpROI

Computes the size of the upper pyramid layer.

Syntax

IppStatus ippiGetPyramidUpROI(IppiSize srcRoi, IppiSize* pDstRoiMin, IppiSize* pDstRoiMax, Ipp32f rate);

Platform-aware functions

IppStatus ippiGetPyramidUpROI_L(IppiSizeL srcRoi, IppiSizeL *pDstRoiMin, IppiSizeL *pDstRoiMax, Ipp32f rate);

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

srcRoiSize
Size of the source pyramid layer ROI in pixels.
pDstRoiSizeMin
Pointer to the minimal size of the destination (upper) pyramid layer ROI in pixels.
pDstRoiSizeMax
Pointer to the maximal size of the destination (upper) pyramid layer ROI in pixels.
rate
Ratio between source and destination layers (1 < rate 10).

Description

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

This function computes possible sizes of the upper pyramid layer pDstRoiSizeMin and pDstRoiSizeMax for a source layer of a given size srcRoiSize and specified size ratio rate between them in accordance with the following formulas:

maximum size pDstRoiSizeMax:


minimum size pDstRoiSizeMin:

if the width and height of the source layer ROI is greater than 1,


if the width and height of the source layer ROI is equal to 1,


NOTE:

Since for the non-integer rate results depend on the computational precision, it is strongly recommended to use this function in computations.

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 has a field with zero or negative value.

ippStsBadArgErr

Indicates an error condition if rate is out of the range.