FilterSobelGetBufferSize

Computes the size of the work buffer for the Sobel filter.

Syntax

IppStatus ippiFilterSobelGetBufferSize (IppiSize dstRoiSize, IppiMaskSize mask, IppNormType normType, IppDataType srcDataType, IppDataType dstDataType, int numChannels, int* pBufferSize);

Include Files

ippi.h

Domain Dependencies

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

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

Parameters

dstRoiSize	Size of the destination ROI in pixels.
mask	Predefined mask of IppiMaskSize type. Possible values are ippMskSize3x3 or ippMskSize5x5.
normType	Normalization mode of IppNormType type.
srcDataType	Data type of the source image.
dstDataType	Data type of the destination image.
numChannels	Number of channels in the image. Possible value is 1.
pBufferSize	Pointer to the size of the external work buffer.

Description

The ippiFilterSobelGetBufferSize function computes the size, in bytes, of the external work buffer needed for the ippiFilterSobel function. The result is stored in the pBufferSize parameter.

For an example on how to use this functions, see the code example provided with the ippiFilterSobel function description.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when pBufferSize is NULL.
ippStsSizeErr	Indicates an error when dstRoiSize is less than, or equal to zero.
ippStsMaskSizeErr	Indicates an error when mask has an illegal value.
ippStsBadArgErr	Indicates an error when normType has an illegal value.
ippStsDataTypeErr	Indicates an error when srcDataType or dstDataType has an illegal value.
ippStsNumChannelsError	Indicates an error when numChannels has an illegal value.