FilterBilateralBorder

Intel® Integrated Performance Primitives Developer Guide and Reference

Download PDF

ID 790148

Date 11/07/2023

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-CABF65A4-D92A-4D41-A6EC-F2488EAF8027

View Details

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

/*******************************************************************************
* 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 Bilateral filtering of an image implemented with Intel(R) Integrated Primitives (Intel(R) IPP) functions:
//     ippiFilterBilateralBorderGetBufferSize
//     ippiFilterBilateralBorderInit
//     ippiFilterBilateralBorder_8u_C1R


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

#define WIDTH  128  /* image width  */
#define HEIGHT  64  /* 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 roiSize = { WIDTH, HEIGHT }; /* Size of source/destination ROI in pixels */
    Ipp8u *pBuffer = NULL;                /* Pointer to the work buffer */
    IppiFilterBilateralSpec *pSpec = NULL;
    int iTmpBufSize = 0, iSpecSize = 0;   /* Common work buffer size */
    IppiBorderType borderType = (IppiBorderType)(ippBorderRepl | ippBorderInMemTop | ippBorderInMemRight);
    Ipp8u borderValue = 0;
    int radius = 1; /* Radius of circular neighborhood what defines pixels for calculation. */
    int numChannels = 1;
    Ipp32f valSqrSigma = 400.0f, posSqrSigma = 100.0f; /* pixel intensity/position */

    pSrc = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &srcStep);
    pDst = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &dstStep);

    check_sts( status = ippiFilterBilateralBorderGetBufferSize(ippiFilterBilateralGauss, roiSize, radius, ipp8u, numChannels, ippDistNormL1, &iSpecSize, &iTmpBufSize) )

    pSpec = (IppiFilterBilateralSpec *)ippsMalloc_8u(iSpecSize);

    pBuffer = ippsMalloc_8u(iTmpBufSize);

    check_sts( status = ippiFilterBilateralBorderInit(ippiFilterBilateralGauss, roiSize, radius, ipp8u, 1, ippDistNormL1, valSqrSigma, posSqrSigma, pSpec) )

    check_sts( status = ippiFilterBilateralBorder_8u_C1R(pSrc + srcStep, srcStep, pDst, dstStep, roiSize, borderType, &borderValue, pSpec, pBuffer) )

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

Parent topic: Filters with Borders

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® Integrated Performance Primitives Developer Guide and Reference

FilterBilateralBorder

Syntax

Include Files

Domain Dependencies

Parameters

Description

Return Values

Example

See Also