Developer Reference for Intel® Integrated Performance Primitives 2019

FilterBoxBorder

Blurs an image using a simple box filter.

Syntax

IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, IppiSize maskSize, IppiBorderType border, const Ipp<datatype>* borderValue, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R 16u_C1R 16s_C1R 32f_C1R

IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, IppiSize maskSize, IppiBorderType border, const Ipp<datatype> borderValue[3], Ipp8u* pBuffer);

Supported values for mod:

8u_C3R 16u_C3R 16s_C3R 32f_C3R
  16u_C4R 16s_C4R  
  16u_AC4R 16s_AC4R  

IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, IppiSize maskSize, IppiBorderType border, const Ipp<datatype> borderValue[4], Ipp8u* pBuffer);

Supported values for mod:

8u_C4R 32f_C4R
8u_AC4R 32f_AC4R

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.

srcStep

Distance, in bytes, between the starting points of consecutive lines in the source image.

pDst

Pointer to the destination image.

dstStep

Distance, in bytes, between the starting points of consecutive lines in the destination image.

roiSize

Size of the destination ROI in pixels.

maskSize

Size of the mask in pixels.

border

Type of border. Possible values are:

ippBorderConst

Values of all border pixels are set to constant.

ippBorderRepl

Border is replicated from the edge pixels.

ippBorderInMem

Border is obtained from the source image pixels in memory.

ippBorderMirror

Border pixels are mirrored from the source image boundary pixels.

Mixed borders are also supported. They can be obtained by the bitwise operation OR between ippBorderRepl and ippBorderInMemTop, ippBorderInMemBottom, ippBorderInMemLeft, ippBorderInMemRight.

borderValue

Constant value to assign to pixels of the constant border. This parameter is applicable only to the ippBorderConst border type.

pBuffer

Pointer to the work buffer.

Description

Before using this function, you need to compute the size of the work buffer pBuffer using the ippiFilterBoxBorderGetBufferSize function.

This function operates with ROI.

This function sets each pixel in the destination image as the average of all pixels of the source image 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. If pSrc is equal to pDst, ippiFilterBoxBorder operates as an in-place function.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when pSrc or pDst is NULL.

ippStsSizeErr

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

ippStsMaskSizeErr

Indicates an error if mask has an illegal value.

ippStsBorderErr

Indicates an error when border has an illegal value.

Example

FilterBoxBorder.c