Developer Reference

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

FilterBorderSetMode

Adds the offset value after filtering operation for
ipp8u
and
ipp16u
data types , and sets the rounding mode.

Syntax

IppStatus ippiFilterBorderSetMode(IppHintAlgorithm
hint
, int
offset
, IppiFilterBorderSpec*
pSpec
);
Include Files
ippi.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
,
ipps.h
Libraries:
ippcore.lib
,
ippvm.lib
,
ipps.lib
Parameters
hint
Suggests using specific code for rounding. Supported values:
ippAlgHintNone
,
ippAlgHintFast
Default modes. The function performs rounding in accordance with the
roundMode
parameter passed to the
Init
function, but function performance takes precedence over accuracy and some output pixels can differ by +-1 from the exact result.
ippAlgHintAccurate
All output pixels are exact; accuracy takes precedence over performance.
offset
Constant that is added to the final signed result before converting it to unsigned for
ipp8u
and
ipp16u
data types.
pSpec
Pointer to the initialized filter specification structure.
Description
This function adds the
offset
value after filtering operation for
ipp8u
and
ipp16u
data types with the
ippiFilterBorder
function:
pDst=(summ(src[i]*kern[i]))+offset
You can also use this function to set the rounding mode for the filtering result.
The
8u_C1R
,
8u_C3R
,
8u_C4R
, and
16s_C1R
FilterBorder
function flavors initialized with the
ipp16s
coefficients support
ippAlgHintNone
and
ippAlgHintAccurate
rounding modes.
Use this function after the
ippiFilterBorderInit
function and before calling
ippiFilterBorder
.
Return Values
ippStsNoErr
Indicates no error.
ippStsNullPtrErr
Indicates an error when one of the specified pointers is
NULL
.
ippStsNotSupportedModeErr
The offset value is not supported (for
ipp16s
and
ipp32f
data types).
ippStsAccurateModeNotSupported
The accurate mode is not supported for some data types. The result of rounding may be not exact.

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: // ippiFilterBorderSetMode // // #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 = ippiFilterBorderSetMode(ippAlgHintNone, 128, 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