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

GetSpatialMoment

Retrieves image spatial moment of the specified order, computed by ippiMoments.

Syntax

IppStatus ippiGetSpatialMoment_64f(const IppiMomentState_64f* pState, int mOrd, int nOrd, int nChannel, IppiPoint roiOffset, Ipp64f* pValue);

Include Files

ippi.h

Domain Dependencies

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

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

Parameters

pState

Pointer to the structure that stores image moments.

mOrd, nOrd

Integer power exponents defining the moment order. These arguments must satisfy the condition 0 mOrd+nOrd 3.

nChannel

The channel for which the moment is returned.

roiOffset

Offset in pixels of the ROI origin (top left corner) from the image origin.

pValue

Pointer to the retrieved moment value.

Description

This function returns the pointer pValue to the spatial moment that was previously computed by the ippiMoments function. All spatial moment values are computed by ippiMoments relative to the image ROI origin. You may also obtain spatial moment values relative to different point in the image, using the appropriate roiOffset settings.

The moment order is specified by the integer exponents mOrd, nOrd.

Return Values

ippStsNoErr

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

ippStsNullPtrErr

Indicates an error condition if pState or pValue pointer is NULL.

ippStsContextMatchErr

Indicates an error condition if a pointer to an invalid structure is passed.

ippStsSizeErr

Indicates an error condition if mOrd + nOrd is greater than 3, or nChannel has an illegal value.