Developer Reference for Intel® Integrated Performance Primitives 2019

FilterMedianBorder

Performs median filtering of an image.

Syntax

Case 1: Operating on one-channel data

IppStatus ippiFilterMedianBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiSize maskSize, IppiBorderType borderType, Ipp<datatype> borderValue, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R 16u_C1R 16s_C1R 32f_C1R

Case 2: Operating on multi-channel data

IppStatus ippiFilterMedianBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiSize maskSize, IppiBorderType borderType, const Ipp<datatype> pBorderValue[3], Ipp8u* pBuffer);

Supported values for mod:

8u_C3R 16u_C3R 16s_C3R
8u_AC4R 16u_AC4R 16s_AC4R

IppStatus ippiFilterMedianBorder_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, IppiSize maskSize, IppiBorderType borderType, const Ipp<datatype> pBorderValue[4], Ipp8u* pBuffer);

Supported values for mod:

8u_C4R 16u_C4R 16s_C4R

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.

dstRoiSize

Size of the destination ROI, in pixels.

maskSize

Size of the filter mask, 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.

borderValue

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

pBorderValue[3], pBorderValue[4]

Pointer to the 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

This function operates with ROI.

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

The ippiFilterMedianBorder function applies a median filter to an image ROI. The anchor cell is the center of the filter kernel. The size of the source image ROI is equal to the size of the destination image ROI dstRoiSize.

This function sets each pixel in the destination buffer as the median value of all source pixels values from the neighborhood of the processed pixel.

This function removes noise and does not cut out signal brightness drops, as an averaging filter does.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

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

ippStsSizeErr

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

ippStsMaskSizeErr

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

ippStsNotEvenStepErr

Indicates an error if one of the step values is not divisible by 4 for floating-point images, or by 2 for short-integer images.

ippStsBorderErr

Indicates an error when borderType has an illegal value.

Example

FilterMedianBorder.c

See Also