Intel IPP Integration Wrappers Developer Guide and Reference

Download PDF
ID 751823
Date 1/18/2023
Public
Document Table of Contents
Document Table of Contents x
Integration Wrappers for Intel(R) Integrated Performance Primitives Developer Guide and Reference
Integration Wrappers for Intel(R) Integrated Performance Primitives Developer Guide and Reference x
Introducing Integration Wrappers for Intel® Integrated Performance Primitives Getting Help and Support Overview Getting Started C Reference C++ Reference Bibliography Notices and Disclaimers
Overview x
Key Features Architecture Conventions Tiling and Threading
Getting Started x
Checking Your Installation Configuring Your Build Environment Finding Documentation for Integration Wrappers Sources
C Reference x
Core Functionality Signal Processing Image Processing
Core Functionality x
Library Scope Initialization and Control Utility Functions
Library Scope Initialization and Control x
iwGetLibVersion iwSetThreadsNum iwGetThreadsNum iwGetThreadsNumDefault iwGetStatusString
Utility Functions x
iwTypeToSize iwTypeIsFloat iwTypeIsSigned iwTypeGetMax iwTypeGetMin iwTypeGetRange iwValueSaturate iwValueAbsToRel iwValueRelToAbs iwRangeWeightCorrector iwAtomic_AddInt Thread Local Storage
Thread Local Storage x
IwTls Structure iwTls_Init iwTls_Set iwTls_Get iwTls_Release iwTls_ReleaseData
Signal Processing x
Signal Processing Structures Vector Tiling Functions Signal Transforms
Vector x
iwsShiftPtr iwsVector_Init iwsVector_InitExternal iwsVector_InitExternalConst iwsVector_Alloc iwsVector_Release iwsVector_GetPtr iwsVector_GetPtrConst iwsVector_BorderAdd iwsVector_BorderSub iwsVector_BorderSet iwsVector_RoiSet iwsVector_GetRoiVector
Tiling Functions x
iwsTile_SetRoi
Signal Transforms x
iwsDCT
Image Processing x
Image Processing Structures Utility Functions Basic Operations Arithmetic Operations Filtering Functions Image Geometry Transforms Color Conversion
Utility Functions x
iwiShiftPtr iwiShiftPtrConst iwiSizeToBorderSize iwiMaskToSize iwiSizeSymToBorderSize Image Tiling Functions
Image x
iwiImage_Init iwiImage_InitExternal iwiImage_InitExternalConst iwiImage_Alloc iwiImage_Release iwiImage_GetPtr iwiImage_GetPtrConst iwiImage_BorderAdd iwiImage_BorderSub iwiImage_BorderSet iwiImage_RoiSet iwiImage_GetRoiImage
Tiling Functions x
iwiTile_GetTileBorder iwiTile_GetMinTileSize iwiTile_CorrectBordersOverlap Basic Tiling API Pipeline Tiling API
Basic Operations x
iwiCopyChannel iwiCopy iwiCopyMerge iwiCopySplit iwiCopyMakeBorder iwiScale iwiScale_GetScaleVals iwiSetChannel iwiSet iwiSwapChannels
Arithmetic Operations x
iwiAdd iwiAddC iwiSub iwiSubC iwiMul iwiMulC iwiDiv iwiDivC
Filtering Functions x
Filtering Structures and Enumerators iwiFilter iwiFilterBox iwiFilterCanny iwiFilterCannyDeriv iwiFilterSobel iwiFilterScharr iwiFilterLaplacian iwiFilterGaussian iwiFilterMorphology iwiFilterMorphology_GetBorderSize iwiFilterBilateral
Image Geometry Transforms x
iwiMirror iwiMirror_GetSrcRoi iwiRotate iwiRotate_GetDstSize Resize WarpAffine
Resize x
Structures and Enumerators iwiResize_SetDefaultParams iwiResize iwiResize_Free iwiResize_InitAlloc iwiResize_Process iwiResize_GetSrcRoi iwiResize_GetBorderSize
WarpAffine x
Edge Smoothing Structures and Enumerators iwiWarpAffine_SetDefaultParams iwiWarpAffine iwiWarpAffine_Free iwiWarpAffine_InitAlloc iwiWarpAffine_Process
Color Conversion x
IwColorFmt Enumerator iwiColorToChannels iwiColorToPlanes iwiColorGetPlaneSize iwiColorConvert
C++ Reference x
Core Functionality Signal Processing Image Processing
Signal Processing x
Basic Classes Signal Transforms
Signal Transforms x
iwsDCT
Image Processing x
Basic Classes Basic Operations Arithmetic Operations Filtering Functions Image Geometry Transforms Color Conversion
Basic Operations x
iwiCopyChannel iwiCopy iwiCopyMerge iwiCopySplit iwiCopyMakeBorder iwiSwapChannels iwiScale iwiScale_GetScaleVals iwiSetChannel iwiSet
Arithmetic Operations x
iwiAdd iwiAddC iwiSub iwiSubC iwiMul iwiMulC iwiDiv iwiDivC
Filtering Functions x
Filtering Structures and Enumerators iwiFilter Syntax Parameters Auxiliary Arguments Description Return Values Exception Values iwiFilterBox iwiFilterCanny iwiFilterCannyDeriv iwiFilterSobel iwiFilterBilateral iwiFilterScharr iwiFilterLaplacian iwiFilterMorphology iwiFilterMorphology_GetBorderSize FilterGaussian
FilterGaussian x
class IwiFilterGaussianParams class IwiFilterGaussian iwiFilterGaussian
Image Geometry Transforms x
iwiMirror_GetSrcRoi iwiMirror_GetDstSize iwiMirror Resize WarpAffine
Resize x
class IwiResizeParams class IwiResize
WarpAffine x
class IwiWarpAffineParams class IwiWarpAffine
Color Conversion x
iwiColorConvert
Integration Wrappers for Intel(R) Integrated Performance Primitives Developer Guide and Reference

iwiFilter

Syntax

class IwiFilterParams: public ::IwiFilterParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiFilterParams, iwiFilter_SetDefaultParams)
    IwiFilterParams(double _divisor = 0, int _offset = 0, IppHintAlgorithm _algoMode = ippAlgHintNone, IppRoundMode _roundMode = ippRndNear);
};
IW_DECL_CPP(IppStatus) iwiFilter(
    const IwiImage         &srcImage,                          
    IwiImage               &dstImage,                          
    const IwiImage         &kernel,                            
    const IwiFilterParams  &auxParams   = IwiFilterParams(),    
    const IwiBorderType    &border      = ippBorderRepl,       
    const IwiTile          &tile        = IwiTile()            
)

Parameters

srcImage

Reference to the source image.

dstImage

Reference to the destination image.

kernel

Reference to the filter kernel image. Kernel must be continuous, one-channel, and of 16s or 32f type.

auxParams

Reference to the auxiliary parameters structure.

border

Extrapolation algorithm for out of image pixels processing. Supported values:

ippBorderConst

 Values of all border pixels are set to a 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.

tile

Reference to the IwiTile structure for tiling. By default, no tiling is applied.

Auxiliary Arguments

Argument Default Value Description

divisor

0

Value by which the computed result is divided for 16s kernel type. If divisor is equal to zero and the sum of the kernel elements is not equal to zero, then the result is normalized by the sum of the kernel elements. Only integer values are supported.

offset

0

An offset value that is added to the final signed result before converting it to unsigned for 8u and 16u data types.

roundMode

IppRndNear

Rounding mode.

algoMode

IppAlgHintNone

Flag enabling intermediate conversions to extend data types and channels support.

Description

This function performs filtering of an image with an arbitrary kernel.

This function supports the following features:

Feature Support
Data types 8u, 16u, 16s, 32s
In-place mode No
64-bit sizes No
Internal threading No
Manual tiling Yes
IwsTile simple tiling Yes
IwsTile pipeline tiling Yes

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsBorderErr

The border value is illegal.

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The value for channels is illegal.

ippStsNotEvenStepErr

The step value is not divisible by the size of elements.

ippStsNotSupportedModeErr

The selected function mode is not supported.

ippStsInplaceModeNotSupportedErr

In-place operation is not supported: srcImage is equal to dstImage.

ippStsNullPtrErr

At least one of the references (except tile) is NULL.
Parent topic: Filtering Functions
Level Two Title