Developer Reference for Intel® Integrated Performance Primitives 2018

FilterBilateralBorder

Performs bilateral filtering of an image.

Syntax

Processing images of 32-bit sizes

IppStatus ippiFilterBilateralBorder_<mod>(const Ipp<srcdatatype>* pSrc, int srcStep, Ipp<dstdatatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiBorderType borderType, Ipp<datatype>* pBorderValue, IppiFilterBilateralSpec* pSpec, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R 8u_C3R 32f_C1R 32f_C3R

Platform-aware functions

IppStatus ippiFilterBilateralBorder_<mod>(const Ipp<srcdatatype>* pSrc, IppSizeL srcStep, Ipp<dstdatatype>* pDst, IppSizeL dstStep, IppiSizeL dstRoiSize, IppiBorderType borderType, Ipp<datatype>* pBorderValue, const IppiFilterBilateralSpec* pSpec, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R_L 8u_C3R_L

Threading layer functions

IppStatus ippiFilterBilateralBorder_<mod>(const Ipp<srcdatatype>* pSrc, IppSizeL srcStep, Ipp<dstdatatype>* pDst, IppSizeL dstStep, IppiSize dstRoiSize, IppiBorderType borderType, Ipp<datatype>* pBorderValue, IppiFilterBilateralSpec_LT* pSpec, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R_L 8u_C3R_L

Include Files

ippi.h

Flavors with the _LT suffix: ippi_tl.h

Flavors with the _L suffix: ippi_l.h

Domain Dependencies

Flavors declared in ippi.h:

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

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

Flavors declared in ippi_tl.h:

Libraries: ippcore.lib, ippvm.lib, ipps.lib, ippi.lib, ippcore_tl.lib, ippi_tl.lib

Parameters

pSrc

Pointer to the source image ROI.

srcStep

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

pDst

Pointer to the destination image ROI.

dstStep

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

dstRoiSize

Size of the source and destination ROI in pixels.

borderType

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.

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

pBorderValue

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

pSpec

Pointer to the bilateral context structure.

pBuffer

Pointer to the work buffer.

Description

This function applies the bilateral filter with the round kernel to the source image. The radius of the kernel is defined in the corresponding initialization function FilterBilateralBorderInit. The bilateral context structure contains the parameters of filtering.

Before using the ippiFilterBilateralBorder function, compute the size of the bilateral context structure and the external buffer using the FilterBilateralBorderGetBufferSize function and initialize the structure using the FilterBilateralBorderInit function.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when pSrc, pDst, pSpec, or pBuffer is NULL.

ippStsSizeErr

Indicates an error when dstRoiSize has a field with a zero or negative value.

ippStsContextMatchErr

Indicates an error when the pSpec structure does not match the function.

ippStsNotEvenStepErr

Indicates an error when one of the step values is not divisible by 4 for floating-point images.

ippStsBorderErr

Indicates an error when borderType has an illegal value.

Example

FilterBilateralBorder.c

See Also