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

OpticalFlowPyrLKGetSize

Computes the size of the pyramidal optical flow state structure.

Syntax

IppStatus ippiOpticalFlowPyrLKGetSize(int winSize, IppiSize roiSize, IppDataType dataType, IppHintAlgorithm hint, int* pStateSize);

Include Files

ippcv.h

Domain Dependencies

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

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

Parameters

winSize

Size of the search window of each pyramid level.

roiSize
Maximal size of the source image (zero level of the pyramid) ROI, in pixels.
dataType
Data type of the image. Possible values: ipp8u, ipp16u, or ipp32f.
hint
Option to select the algorithmic implementation of the transform function.
pStateSize
Pointer to the size of the state struture.

Description

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

This function computes the size of the pState structure that is required to calculate the optical flow between two images in the centered window of size winSize*winSize using the pyramidal Lucas-Kanade [Bou99] algorithm. The hint argument specifies the computation algorithm. The pState structure is used by the ippiOpticalFlowPyrLK function and can be applied to process images with size not greater than roiSize.

Return Values

ippStsNoErr

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

ippStsNullPtrErr

Indicates an error when pStateSize is NULL.

ippStsDataTypeErr

Indicates an error when dataType has an illegal value.

ippStsSizeErr

Indicates an error when roiSize has a field with a zero or negative value; or when winSize is less than, or equal to zero.

See Also