Intel IPP Integration Wrappers Developer Guide and Reference

Download
ID 751823
Date 9/30/2019
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
<span class='option'>iwGetLibVersion</span> <span class='option'>iwSetThreadsNum</span> <span class='option'>iwGetThreadsNum</span> <span class='option'>iwGetThreadsNumDefault</span> <span class='option'>iwGetStatusString</span>
Utility Functions x
<span class='option'>iwTypeToSize</span> <span class='option'>iwTypeIsFloat</span> iwTypeIsSigned <span class='option'>iwTypeGetMax</span> <span class='option'>iwTypeGetMin</span> <span class='option'>iwTypeGetRange</span> <span class='option'>iwValueSaturate</span> iwValueAbsToRel <span class='option'>iwValueRelToAbs</span> iwRangeWeightCorrector iwAtomic_AddInt Thread Local Storage
Thread Local Storage x
<span class='keyword'>IwTls</span> Structure <span class='option'>iwTls_Init</span> <span class='option'>iwTls_Set</span> <span class='option'>iwTls_Get</span> <span class='option'>iwTls_Release</span> <span class='option'>iwTls_ReleaseData</span>
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
<span class='option'>iwiShiftPtr</span> <span class='option'>iwiShiftPtrConst</span> <span class='option'>iwiSizeToBorderSize</span> <span class='option'>iwiMaskToSize</span> <span class='option'>iwiSizeSymToBorderSize</span> Image Tiling Functions
Image x
<span class='option'>iwiImage_Init</span> <span class='option'>iwiImage_InitExternal</span> <span class='option'>iwiImage_InitExternalConst</span> <span class='option'>iwiImage_Alloc</span> <span class='option'>iwiImage_Release</span> <span class='option'>iwiImage_GetPtr</span> <span class='option'>iwiImage_GetPtrConst</span> <span class='option'>iwiImage_BorderAdd</span> <span class='option'>iwiImage_BorderSub</span> <span class='option'>iwiImage_BorderSet</span> <span class='option'>iwiImage_RoiSet</span> <span class='option'>iwiImage_GetRoiImage</span>
Tiling Functions x
<span class='option'>iwiTile_GetTileBorder</span> <span class='option'>iwiTile_GetMinTileSize</span> <span class='option'>iwiTile_CorrectBordersOverlap</span> Basic Tiling API Pipeline Tiling API
Basic Operations x
<span class='option'>iwiCopyChannel</span> <span class='option'>iwiCopy</span> <span class='option'>iwiCopyMerge</span> <span class='option'>iwiCopySplit</span> <span class='option'>iwiCopyMakeBorder</span> <span class='option'>iwiScale</span> <span class='option'>iwiScale_GetScaleVals</span> <span class='option'>iwiSetChannel</span> <span class='option'>iwiSet</span> <span class='option'>iwiSwapChannels</span>
Arithmetic Operations x
iwiAdd iwiAddC iwiSub iwiSubC iwiMul iwiMulC iwiDiv iwiDivC
Filtering Functions x
Filtering Structures and Enumerators iwiFilter iwiFilterBox <span class='option'>iwiFilterCanny</span> <span class='option'>iwiFilterCannyDeriv</span> <span class='option'>iwiFilterSobel</span> <span class='option'>iwiFilterScharr</span> <span class='option'>iwiFilterLaplacian</span> <span class='option'>iwiFilterGaussian</span> <span class='option'>iwiFilterMorphology</span> <span class='option'>iwiFilterMorphology_GetBorderSize</span> <span class='option'>iwiFilterBilateral</span>
Image Geometry Transforms x
<span class='option'>iwiMirror</span> <span class='option'>iwiMirror_GetSrcRoi</span> <span class='option'>iwiRotate</span> <span class='option'>iwiRotate_GetDstSize</span> Resize WarpAffine
Resize x
Structures and Enumerators <span class='option'>iwiResize_SetDefaultParams</span> <span class='option'>iwiResize</span> <span class='option'>iwiResize_Free</span> <span class='option'>iwiResize_InitAlloc</span> <span class='option'>iwiResize_Process</span> <span class='option'>iwiResize_GetSrcRoi</span> <span class='option'>iwiResize_GetBorderSize</span>
WarpAffine x
Edge Smoothing Structures and Enumerators <span class='option'>iwiWarpAffine_SetDefaultParams</span> <span class='option'>iwiWarpAffine</span> <span class='option'>iwiWarpAffine_Free</span> <span class='option'>iwiWarpAffine_InitAlloc</span> <span class='option'>iwiWarpAffine_Process</span>
Color Conversion x
<span class='keyword'>IwColorFmt</span> Enumerator <span class='option'>iwiColorToChannels</span> <span class='option'>iwiColorToPlanes</span> <span class='option'>iwiColorGetPlaneSize</span> <span class='option'>iwiColorConvert</span>
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
<span class='option'>iwiCopyChannel</span> <span class='option'>iwiCopy</span> <span class='option'>iwiCopyMerge</span> <span class='option'>iwiCopySplit</span> <span class='option'>iwiCopyMakeBorder</span> <span class='option'>iwiSwapChannels</span> <span class='option'>iwiScale</span> <span class='option'>iwiScale_GetScaleVals</span> <span class='option'>iwiSetChannel</span> <span class='option'>iwiSet</span>
Arithmetic Operations x
iwiAdd iwiAddC iwiSub iwiSubC iwiMul iwiMulC iwiDiv iwiDivC
Filtering Functions x
Filtering Structures and Enumerators iwiFilter iwiFilterBox <span class='option'>iwiFilterCanny</span> <span class='option'>iwiFilterCannyDeriv</span> <span class='option'>iwiFilterSobel</span> <span class='option'>iwiFilterBilateral</span> <span class='option'>iwiFilterScharr</span> <span class='option'>iwiFilterLaplacian</span> <span class='option'>iwiFilterMorphology</span> <span class='option'>iwiFilterMorphology_GetBorderSize</span> FilterGaussian
FilterGaussian x
class <span class='keyword'>IwiFilterGaussianParams</span> class <span class='keyword'>IwiFilterGaussian</span> <span class='option'>iwiFilterGaussian</span>
Image Geometry Transforms x
<span class='option'>iwiMirror_GetSrcRoi</span> <span class='option'>iwiMirror_GetDstSize</span> <span class='option'>iwiMirror</span> Resize WarpAffine
Resize x
class <span class='keyword'>IwiResizeParams</span> class <span class='keyword'>IwiResize</span>
WarpAffine x
class <span class='keyword'>IwiWarpAffineParams</span> class <span class='keyword'>IwiWarpAffine</span>
Color Conversion x
<span class='option'>iwiColorConvert</span>
Integration Wrappers for Intel(R) Integrated Performance Primitives Developer Guide and Reference

iwiFilterBox

Syntax 
class IwiFilterBoxParams: public ::IwiFilterBoxParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiFilterBoxParams, iwiFilterBox_SetDefaultParams)
    IwiFilterBoxParams(IwiChDescriptor _chDesc = iwiChDesc_None);
};
IW_DECL_CPP(IppStatus) iwiFilterBox(
    const IwiImage             &srcImage,                           
    IwiImage                   &dstImage,                          
    IwiSize                     kernel,                             
    const IwiFilterBoxParams   &auxParams   = IwiFilterBoxParams(), 
    const IwiBorderType        &border      = ippBorderRepl,        
    const IwiTile              &tile        = IwiTile()             
)
Parameters

srcImage

Reference to the source image.

dstImage

Reference to the destination image.

kernel

Size of the filter kernel.

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

chDesc

iwiChDesc_None

Special channels processing mode.
Description

This function performs box filtering of an image.

This function supports the following features:

Feature Support
Data types 8u, 16u, 16s, 32f
Channel types C1, C3, C4, C4M1110
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 size of elements.

ippStsNotSupportedModeErr

The selected function mode is not supported.

ippStsInplaceModeNotSupportedErr

In-place operation is not supported: pSrc is equal to pDst.

ippStsNullPtrErr

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

Did you find the information on this page useful?

Characters remaining:

Feedback Message