Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

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

Document Table of Contents

OpticalFlowPyrLKInit

Initializes the state structure for optical flow calculation.

Syntax

IppStatus ippiOpticalFlowPyrLKInit_<mod>(IppiOptFlowPyrLK_<mod>** ppState, IppiSize roiSize, int winSize, IppHintAlgorithm hint, Ipp8u* pStateBuf);

Supported values for mod:

8u_C1R

16u_C1R

32f_C1R

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

ppState

Double pointer to the optical flow state structure to be initialized.

roiSize
Maximal size of the source image (zero level of the pyramid) ROI, in pixels.
winSize
Size of the search window of each pyramid level.
hint
Option to select the algorithmic implementation of the transform function.
pStateBuf
Pointer to the work buffer for the state structure.

Description

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

This function initializes the ppState 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 ppState 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 ppState is NULL.

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