FilterBox

Blurs an image using a simple box filter.

Syntax

IppStatus ippiFilterBox_64f_C1R(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiSize maskSize, IppiPoint anchor);

Include Files
ippi.h

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

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

Parameters
pSrc

Pointer to the source image ROI.

srcStep

Distance in bytes between starts of consecutive lines in the source image.

pDst

Pointer to the destination image ROI.

dstStep

Distance in bytes between starts of consecutive lines in the destination image.

dstRoiSize

Size of the destination ROI in pixels.

maskSize

Size of the mask in pixels.

anchor

Anchor cell specifying the mask alignment with respect to the position of the input pixel.

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

This function sets each pixel in the destination image as the average of all the input image pixels in the rectangular neighborhood of size maskSize with the anchor cell at that pixel. This has the effect of smoothing or blurring on the input image. To ensure valid operation when image boundary pixels are processed, the application must correctly define additional border pixels (see Borders in Neighborhood Operations).

Return Values
ippStsNoErr
Indicates no error. Any other value indicates an error or a warning.
ippStsNullPtrErr
Indicates an error if pSrc, pDst, or pSrcDst is NULL.
ippStsSizeErr
Indicates an error if dstRoiSize has a field with zero or negative value.
ippStsStepErr
Indicates an error if srcStep or dstStep has a zero or negative value.
ippStsMaskSizeErr
Indicates an error if maskSize has a field with zero or negative value.
ippStsAnchorErr
Indicates an error if anchor is outside the mask size.
ippStsMemAllocErr
Indicates a memory allocation error.

pSrc	Pointer to the source image ROI.
srcStep	Distance in bytes between starts of consecutive lines in the source image.
pDst	Pointer to the destination image ROI.
dstStep	Distance in bytes between starts of consecutive lines in the destination image.
dstRoiSize	Size of the destination ROI in pixels.
maskSize	Size of the mask in pixels.
anchor	Anchor cell specifying the mask alignment with respect to the position of the input pixel.

ippStsNoErr	Indicates no error. Any other value indicates an error or a warning.
ippStsNullPtrErr	Indicates an error if pSrc, pDst, or pSrcDst is NULL.
ippStsSizeErr	Indicates an error if dstRoiSize has a field with zero or negative value.
ippStsStepErr	Indicates an error if srcStep or dstStep has a zero or negative value.
ippStsMaskSizeErr	Indicates an error if maskSize has a field with zero or negative value.
ippStsAnchorErr	Indicates an error if anchor is outside the mask size.
ippStsMemAllocErr	Indicates a memory allocation error.