FilterGaussianBorder
Performs Gaussian filtering of an image with user-defined borders.
Syntax
IppStatus ippiFilterGaussianBorder_<mod>(const Ipp<datatype>*
pSrc
, int
srcStep
, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
roiSize
, Ipp<datatype>
borderValue
, IppFilterGaussianSpec*
pSpec
, Ipp8u*
pBuffer
);
Supported values for
mod
:8u_C1R | 16u_C1R | 16s_C1R | 32f_C1R |
IppStatus ippiFilterGaussianBorder_<mod>(const Ipp<datatype>*
pSrc
, int
srcStep
, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
roiSize
, Ipp<datatype>
borderValue[3]
, IppFilterGaussianSpec*
pSpec
, Ipp8u*
pBuffer
);
Supported values for
mod
:8u_C3R | 16u_C3R | 16s_C3R | 32f_C3R |
Include Files
ippcv.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
,
ipps.h
,
ippi.h
Libraries:
ippcore.lib
,
ippvm.lib
,
ipps.lib
,
ippi.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.
- roiSize
- Size of the source and destination image ROI in pixels.
- borderValue
- Constant value to assign to pixels of the constant border. This parameter is applicable only to theippBorderConstborder type.
- pSpec
- Pointer to the Gaussian specification structure.
- pBuffer
- Pointer to the work buffer.
Description
This function operates with ROI (see Regions of Interest in Intel IPP).
This function applies the Gaussian filter to the source image ROI
pSrc
. The kernel of the Gaussian filter is the matrix of size kernelSize
xkernelSize
with the standard deviation sigma
. The values of the Gaussian kernel elements are computed by the FilterGaussianInit function. Elements of the kernel are normalized. The anchor cell is the center of the kernel.Before using the
ippiFilterGaussianBorder
function, compute the size of the Gaussian specification structure and the external buffer using the FilterGaussianGetBufferSize function and initialize the structure using the FilterGaussianInit function.Return Values
- ippStsNoErr
- Indicates no error.
- ippStsNullPtrErr
- Indicates an error when one of the specified pointers isNULL.
- ippStsSizeErr
- Indicates an error whenroiSizehas a field with a zero or negative value.
- ippStsStepErr
- Indicates an error whensrcStepordstStepis less thanroiSize.width*<pixelSize>.
- ippStsNotEvenStepErr
- Indicates an error when one of the step values is not divisible bysizeof(Ipp<dataType>).
- ippStsBorderErr
- Indicates an error whenborderTypehas an illegal value.
- ippStsBadArgErr
- Indicates an error whenkernelSizeis even, or less than 3.
Example
/*******************************************************************************
* Copyright 2015-2021 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 a filtering an image using a general integer rectangular kernel
// implemented with Intel(R) Integrated Primitives (Intel(R) IPP) functions:
// ippiImageJaehne_32f_C1R
// ippiFilterGaussianInit
// ippiFilterGaussianBorder_32f_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;
Ipp32f* 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 */
Ipp32u kernelSize = 3;
Ipp32f sigma = 0.35f;
Ipp8u *pBuffer = NULL; /* Pointer to the work buffer */
IppFilterGaussianSpec* pSpec = NULL; /* context structure */
int iTmpBufSize = 0, iSpecSize = 0; /* Common work buffer size */
IppiBorderType borderType = ippBorderRepl;
Ipp8u borderValue = 0;
int numChannels = 1;
pSrc = ippiMalloc_32f_C1(roiSize.width, roiSize.height, &srcStep);
pDst = ippiMalloc_32f_C1(roiSize.width, roiSize.height, &dstStep);
check_sts( status = ippiImageJaehne_32f_C1R(pSrc, srcStep, roiSize) ) /* fill source image */
check_sts( status = ippiFilterGaussianGetBufferSize(roiSize, kernelSize, ipp32f,
numChannels, &iSpecSize, &iTmpBufSize) )
pSpec = (IppFilterGaussianSpec *)ippsMalloc_8u(iSpecSize);
pBuffer = ippsMalloc_8u(iTmpBufSize);
check_sts( status = ippiFilterGaussianInit(roiSize, kernelSize, sigma,
borderType, ipp32f, numChannels, pSpec, pBuffer) )
check_sts( status = ippiFilterGaussianBorder_32f_C1R(pSrc, srcStep, pDst, dstStep,
roiSize, 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;
}