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

SqrDistanceNormGetBufferSize

Computes the size of the work buffer for the ippiSqrDistanceNorm function.

Syntax

IppStatus ippiSqrDistanceNormGetBufferSize (IppiSize srcRoiSize, IppiSize tplRoiSize, IppEnum algType, int* pBufferSize);

Include Files

ippi.h

Parameters

srcRoiSize, tplRoiSize

Size of the source/template ROI in pixels.

algType

Bit-field mask for the algorithm type definition. Possible values are the results of composition of the IppAlgType, IppiROIShape, and IppiNormOp values.

pBufferSize

Pointer to the size of the work buffer.

Description

The ippiSqrDistanceNormGetBufferSize function computes the size, in bytes, of the external work buffer needed for the function that computes the Euclidean distance between an image and a template. The result is stored in the pBufferSize parameter.

Return Values

ippStsNoErr

Indicates no error.

ippStsSizeErr

Indicates an error when:

  • srcRoiSize or tplRoiSize is negative, or equal to zero
  • the value of srcRoiSize is less than the corresponding value of tplRoiSize

ippStsAlgTypeErr

Indicates an error when:

  • the result of the bitwise AND operation between the algType and ippAlgMask values differs from the ippAlgAuto, ippAlgDirect, or ippAlgFFT values.
  • the result of the bitwise AND operation between the algType and ippiROIMask values differs from the ippiROIFull, ippiROISame, or ippiROIValid values.
  • the result of the bitwise AND operation between the algType and ippiNormMask values differs from the ippiNormNone or ippiNorm values.

ippStsNullErr

Indicates an error when the pBufferSize is NULL.

See Also