Developer Reference

  • 2020
  • 07/15/2020
  • Public Content
Contents

FilterBorder

Filters an image using a rectangular filter.

Syntax

Case 1: Operation on one-channel data
IppStatus ippiFilterBorder_<mod>(const Ipp<datatype>*
pSrc
, int
srcStep
, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
dstRoiSize
, IppiBorderType
border
, const Ipp<datatype>
borderValue[1]
, const IppiFilterBorderSpec*
pSpec
, Ipp8u*
pBuffer
);
Supported values for
mod
:
8u_C1R
16u_C1R
16s_C1R
32f_C1R
64f_C1R
Case 2: Operation on multi-channel data
IppStatus ippiFilterBorder_<mod>(const Ipp<datatype>*
pSrc
, int
srcStep
, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
dstRoiSize
, IppiBorderType
border
, const Ipp<datatype>
borderValue[3]
, const IppiFilterBorderSpec*
pSpec
, Ipp8u*
pBuffer
);
Supported values for
mod
:
8u_C3R
16u_C3R
16s_C3R
32f_C3R
IppStatus ippiFilterBorder_<mod>(const Ipp<datatype>*
pSrc
, int
srcStep
, Ipp<datatype>*
pDst
, int
dstStep
, IppiSize
dstRoiSize
, IppiBorderType
border
, const Ipp<datatype>
borderValue[4]
, const IppiFilterBorderSpec*
pSpec
, Ipp8u*
pBuffer
);
Supported values for
mod
:
8u_C4R
16u_C4R
16s_C4R
32f_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 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 starting points of consecutive lines in the destination image.
dstRoiSize
Size of the source and destination image ROI 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.
Mixed borders are also supported. They can be obtained by the bitwise operation
OR
between the
ippBorderRepl
or
ippBorderConst
values and
ippBorderInMemTop
,
ippBorderInMemBottom
,
ippBorderInMemLeft
,
ippBorderInMemRight
.
borderValue
Constant value to assign to pixels of the constant border. This parameter is applicable only to the
ippBorderConst
border type.
pSpec
Pointer to the filter specification structure.
pBuffer
Pointer to the work buffer for filtering operations.
Description
Before using this function, you need to initialize the filter specification structure using the
ippiFilterBorderInit
function.
This function operates with ROI.
This function performs filtering of a rectangular ROI inside a two-dimensional image using a specified structure
pSpec
. Type of the image border is defined by the value of the
border
parameter.
To change the function behavior (add offset to the result or set the rounding mode), use
ippiFilterBorderSetMode
after the
ippiFilterBorderInit
function.
Return Values
ippStsNoErr
Indicates no error.
ippStsNullPtrErr
Indicates an error when one of the specified pointers is
NULL
.
ippStsSizeErr
Indicates an error when
dstRoiSize
has a field with a zero or negative value, or if
dstRoiSize.width
is more than the maximum ROI
roiWidth
passed to the initialization function.
ippStsStepErr
Indicates an error when the
srcStep
value is less than, or equal to zero.
ippStsBorderErr
Indicates an error when
border
has an illegal value.

Example

/******************************************************************************* * Copyright 2015-2020 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 filtering an image using a general integer rectangular kernel // implemented with Intel(R) Integrated Primitives (Intel(R) IPP) functions: // ippiFilterBorderGetSize // ippiFilterBorderInit_16s // ippiFilterBorder_8u_C1R #include <stdio.h> #include "ipp.h" #define WIDTH 128 /* image width */ #define HEIGHT 64 /* image height */ const Ipp16s kernel[3*3] = { 0, 1, 0, 1, 0, 1, 0, 1, 0 }; /* 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 */ IppiSize kernelSize = { 3, 3 }; Ipp8u *pBuffer = NULL; /* Pointer to the work buffer */ IppiFilterBorderSpec* pSpec = NULL; /* context structure */ int iTmpBufSize = 0, iSpecSize = 0; /* Common work buffer size */ IppiBorderType borderType = ippBorderRepl; Ipp8u borderValue = 0; int numChannels = 1; pSrc = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &srcStep); pDst = ippiMalloc_8u_C1(roiSize.width, roiSize.height, &dstStep); check_sts( status = ippiFilterBorderGetSize(kernelSize, roiSize, ipp8u, ipp16s, numChannels, &iSpecSize, &iTmpBufSize) ) pSpec = (IppiFilterBorderSpec *)ippsMalloc_8u(iSpecSize); pBuffer = ippsMalloc_8u(iTmpBufSize); check_sts( status = ippiFilterBorderInit_16s(kernel, kernelSize, 4, ipp8u, numChannels, ippRndNear, pSpec) ) check_sts( status = ippiFilterBorder_8u_C1R(pSrc, 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; }

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804