FilterMedianBorder

Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

Download PDF

ID 790148

Date 3/22/2024

Version

Public

Visible to Intel only — GUID: GUID-F70F9576-DAF2-4C94-869F-1127E741A17F

View Details

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

Supported values for mod:

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

Supported values for mod:

8u_C4R

16u_C4R

16s_C4R

Case 3: Operating on one-channel data with Threading Layer (TL) functions based on the Classic API

Supported values for mod:

8u_C1R_T

Case 4: Operating on multi-channel data with Threading Layer (TL) functions based on the Classic API

Supported values for mod:

8u_C3R_T

8u_AC4R_T

Supported values for mod:

8u_C4R_T

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

/*******************************************************************************
* Copyright 2015 Intel Corporation.
*
*
* This software and the related documents are Intel copyrighted materials, and your use of them is governed by
* the express license under which they were provided to you ('License'). Unless the License provides otherwise,
* you may not use, modify, copy, publish, distribute, disclose or transmit this software or the related
* documents without Intel's prior written permission.
* This software and the related documents are provided as is, with no express or implied warranties, other than
* those that are expressly stated in the License.
*******************************************************************************/

//   A simple example of performing Bluring an image using a median filter
// implemented with Intel(R) Integrated Performance Primitives (Intel(R) IPP) functions:
//     ippiFilterMedianBorderGetBufferSize
//     ippiFilterMedianBorder_8u_C1R


#include <stdio.h>
#include "ipp.h"

#define WIDTH  16  /* image width  */
#define HEIGHT 16  /* image height */

/* Next two defines are created to simplify code reading and understanding */
#define EXIT_MAIN exitLine:                                  /* Label for Exit */
#define check_sts(st) if((st) != ippStsNoErr) goto exitLine; /* Go to Exit if Intel(R) IPP function returned status different from ippStsNoErr */

/* Results of ippMalloc() are not validated because Intel(R) IPP functions perform bad arguments check and will return an appropriate status  */

int main(void)
{
    IppStatus status = ippStsNoErr;
    Ipp8u* pSrc = NULL, *pDst = NULL;     /* Pointers to source/destination images */
    int srcStep = 0, dstStep = 0;         /* Steps, in bytes, through the source/destination images */
    IppiSize srcImageSize = { WIDTH+1, HEIGHT+1}; /* size of source image in pixels */
    IppiSize roiSize = { WIDTH, HEIGHT }; /* Size of source/destination ROI in pixels */
    Ipp8u *pBuffer = NULL;                /* Pointer to the work buffer */
    int iTmpBufSize = 0;                  /* Common work buffer size */
    IppiBorderType borderType = (IppiBorderType)(ippBorderRepl | ippBorderInMemTop | ippBorderInMemRight);
    Ipp8u borderValue = 254;
    IppiSize maskSize = { 3, 3 };
    int numChannels = 1;

    /* memory allocation */
    pSrc = ippiMalloc_8u_C1(srcImageSize.width, srcImageSize.height, &srcStep);
    pDst = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &dstStep);

    check_sts( status = ippiFilterMedianBorderGetBufferSize(roiSize, maskSize, ipp8u, numChannels, &iTmpBufSize) )

    pBuffer = ippsMalloc_8u(iTmpBufSize);

    check_sts( status = ippiFilterMedianBorder_8u_C1R(pSrc + srcStep, srcStep, pDst, dstStep, roiSize, maskSize, borderType, borderValue, pBuffer) )

EXIT_MAIN
    ippsFree(pBuffer);
    ippiFree(pSrc);
    ippiFree(pDst);
    printf("Exit status %d (%s)\n", (int)status, ippGetStatusString(status));
    return (int)status;
}

Parent topic: Median Filters

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

FilterMedianBorder

Syntax

Include Files

Domain Dependencies

Parameters

Description

Return Values

Example

See Also