FilterBoxBorder
Blurs an image using a simple box filter.
Syntax
IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>*
pSrc
, int srcStep, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
roiSize
, IppiSize
maskSize
, IppiBorderType
border
, const Ipp<datatype>*
borderValue
, Ipp8u*
pBuffer
);
Supported values for
mod
:8u_C1R | 16u_C1R | 16s_C1R | 32f_C1R |
IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>*
pSrc
, int srcStep, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
roiSize
, IppiSize
maskSize
, IppiBorderType
border
, const Ipp<datatype>
borderValue[3]
, Ipp8u*
pBuffer
);
Supported values for
mod
:8u_C3R | 16u_C3R | 16s_C3R | 32f_C3R |
16u_C4R | 16s_C4R | ||
16u_AC4R | 16s_AC4R |
IppStatus ippiFilterBoxBorder_<mod>(const Ipp<datatype>*
pSrc
, int srcStep, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
roiSize
, IppiSize
maskSize
, IppiBorderType
border
, const Ipp<datatype>
borderValue[4]
, Ipp8u*
pBuffer
);
Supported values for
mod
:8u_C4R | 32f_C4R |
8u_AC4R | 32f_AC4R |
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.
- roiSize
- Size of the destination ROI in pixels.
- maskSize
- Size of the mask in pixels.
- border
- 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.
- ippBorderMirror
- Border pixels are mirrored from the source image boundary pixels.
Mixed borders are also supported. They can be obtained by the bitwise operation OR betweenippBorderReplandippBorderInMemTop,ippBorderInMemBottom,ippBorderInMemLeft,ippBorderInMemRight. - borderValue
- Constant value to assign to pixels of the constant border. This parameter is applicable only to theippBorderConstborder type.
- pBuffer
- Pointer to the work buffer.
Description
Before using this function, you need to compute the size of the work buffer
pBuffer
using the ippiFilterBoxBorderGetBufferSize
function. This function operates with ROI.
This function sets each pixel in the destination image as the average of all pixels of the source image in the rectangular neighborhood of size
maskSize
with the anchor cell at that pixel. This has the effect of smoothing or blurring the input image. To ensure valid operation when image boundary pixels are processed, the application must correctly define additional border pixels. If pSrc
is equal to pDst
, ippiFilterBoxBorder
operates as an in-place function.Return Values
- ippStsNoErr
- Indicates no error.
- ippStsNullPtrErr
- Indicates an error whenpSrcorpDstisNULL.
- ippStsSizeErr
- Indicates an error ifroiSizehas a field with zero or negative value.
- ippStsMaskSizeErr
- Indicates an error ifmaskhas an illegal value.
- ippStsBorderErr
- Indicates an error whenborderhas an illegal value.
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 Bluring an image using a simple box filter
// implemented with Intel(R) Integrated Primitives (Intel(R) IPP) functions:
// ippiFilterBoxBorderGetBufferSize
// ippiFilterBoxBorder_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 */
int iTmpBufSize = 0; /* Common work buffer size */
IppiBorderType borderType = ippBorderRepl;
Ipp8u borderValue = 254;
IppiSize maskSize = {5,5};
int numChannels = 1;
pSrc = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &srcStep);
pDst = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &dstStep);
check_sts( status = ippiFilterBoxBorderGetBufferSize(roiSize, maskSize, ipp8u, numChannels, &iTmpBufSize) )
pBuffer = ippsMalloc_8u(iTmpBufSize);
check_sts( status = ippiFilterBoxBorder_8u_C1R(pSrc, 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;
}