FilterBox

Blurs an image using a simple box filter.

Syntax

Case 1: Not-in-place operation

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

Supported values for mod:

8u_C1R 16u_C1R 16s_C1R 32f_C1R 64f_C1R
8u_C3R 16u_C3R 16s_C3R 32f_C3R
8u_C4R 16u_C4R 16s_C4R 32f_C4R
8u_AC4R 16u_AC4R 16s_AC4R 32f_AC4R

Case 2: In-place operation

IppStatus ippiFilterBox_<mod>(Ipp<datatype>* pSrcDst, int srcDstStep, IppiSize roiSize, IppiSize maskSize, IppiPoint anchor);

Supported values for mod:

8u_C1IR 16u_C1IR 16s_C1IR 32f_C1IR
8u_C3IR 16u_C3IR 16s_C3IR 32f_C3IR
8u_C4IR 16u_C4IR 16s_C4IR 32f_C4IR
8u_AC4IR 16u_AC4IR 16s_AC4IR 32f_AC4IR

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.

roiSize

Size of the source and destination ROI in pixels for the in-place operation.

pSrcDst

Pointer to the source and destination image ROIs for the in-place operation.

srcDstStep

Distance in bytes between starts of consecutive lines in the source and destination image buffer for the in-place operation.

maskSize

Size of the mask in pixels.

anchor

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

Description

The function ippiFilterBox is declared in the ippi.h file. It 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 the input image. To ensure valid operation when image boundary pixels are processed, the application must correctly define additional border pixels (see Borders).

Return Values

ippStsNoErr

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

ippStsNullPtrErr

Indicates an error condition if pSrc, pDst, or pSrcDst is NULL.

ippStsSizeErr

Indicates an error condition if dstRoiSize or roiSize has a field with zero or negative value.

ippStsStepErr

Indicates an error condition if srcStep, dstStep, or srcDstStep has a zero or negative value.

ippStsMaskSizeErr

Indicates an error condition if maskSize has a field with zero or negative value.

ippStsAnchorErr

Indicates an error condition if anchor is outside the mask size.

ippStsMemAllocErr

Indicates a memory allocation error.

Submit feedback on this help topic

Copyright © 2000 - 2010, Intel Corporation. All rights reserved.