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 iwiTilePipeline_Init iwiTilePipeline_InitChild iwiTilePipeline_GetDstBufferSize iwiTilePipeline_SetRoi iwiTilePipeline_BuildBorder iwiTilePipeline_GetBoundedSrcRect iwiTilePipeline_GetBoundedDstRect iwiTilePipeline_GetMinTileSize
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 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

Pipeline Tiling API

iwiTilePipeline_Init

Initializes a pipeline tiling root node for the IwiTile structure. 

IW_DECL(IppStatus) iwiTilePipeline_Init(
    IwiTile                *pTile,             // [in] Pointer to IwiTile structure
    IwiSize                 tileSizeMax,       // [in] Maximum tile size for intermediate buffers size calculation
    IwiSize                 dstImageSize,      // [in] Destination image size for current operation
    const IwiBorderType    *pBorderType,       // [in] Border type for the current operation. NULL if operation doesn't have a border
    const IwiBorderSize    *pBorderSize,       // [in] Border size for the current operation. NULL if operation doesn't have a border
    const IwiTileTransform *pTransformStruct   // [in] Initialized transform structure if operation performs geometric transformation. NULL if operation doesn't perform transformation
);

iwiTilePipeline_InitChild

Initializes a pipeline tiling child node for the IwiTile structure. 

IW_DECL(IppStatus) iwiTilePipeline_InitChild(
    IwiTile                *pTile,             // [in] Pointer to IwiTile structure
    IwiTile                *pParent,           // [in] Pointer to IwiTile structure of previous operation
    const IwiBorderType    *pBorderType,       // [in] Border type for the current operation. NULL if operation doesn't have a border
    const IwiBorderSize    *pBorderSize,       // [in] Border size for the current operation. NULL if operation doesn't have a border
    const IwiTileTransform *pTransformStruct   // [in] Initialized transform structure if operation performs geometric transformation. NULL if operation doesn't perform transformation
);

Releases allocated data from the IwiTile structure. 

IW_DECL(void) iwiTilePipeline_Release(
    IwiTile *pTile  // [in] Pointer to IwiTile structure
);

iwiTilePipeline_GetDstBufferSize

Returns the size of the pipeline tiling intermediate buffer. 

IW_DECL(IppStatus) iwiTilePipeline_GetDstBufferSize(
    const IwiTile   *pTile,         // [in]     Pointer to IwiTile structure
    IwiSize         *pDstSize       // [out]    Minimal required size of destination intermediate buffer
);

iwiTilePipeline_SetRoi

Sets current tile rectangle for the pipeline to process. 

IW_DECL(IppStatus) iwiTilePipeline_SetRoi(
    IwiTile         *pTile,         // [in] Pointer to IwiTile structure
    IwiRoi           tileRoi        // [in] Tile offset and size
);

iwiTilePipeline_BuildBorder

This function builds the border for the current tile source buffer. This enables passing only InMem borders to the function, thus reducing possiblity of border conflicts on image boundary.

By default, this function is not applied to the first image in the pipeline, it is applied only to intermediate buffers, but it can be used manually to construct the border for it as well.

IW_DECL(IppStatus) iwiTilePipeline_BuildBorder(
    const IwiTile   *pTile,          // [in]     Pointer to the IwiTile structure for the current tile
    IwiImage        *pSrcImage,      // [in,out] Pointer to the source image for which the border is built
    IwiBorderType   *pBorder,        // [in,out] Extrapolation algorithm for out of image pixels. Updated InMem flags will be returned here.
    const Ipp64f    *pBorderVal      // [in]     Pointer to array of border values for ippBorderConst. One element for each channel. Can be NULL for any other border.
);

Calculates actual border parameter with InMem flags for the current tile absolute and relative offsets and sizes. 

IW_DECL(IppStatus) iwiTilePipeline_GetTileBorder(
    const IwiTile   *pTile,         // [in]     Pointer to the IwiTile structure
    IwiBorderType   *pBorder        // [in,out] Pointer to the border type, actual tile border will be written here.
);

iwiTilePipeline_GetBoundedSrcRect

Checks for image and buffer boundaries for the source buffer and limits tile rectangle. 

IW_DECL(IppStatus) iwiTilePipeline_GetBoundedSrcRoi(
    const IwiTile   *pTile,         // [in]     Pointer to IwiTile structure
    IwiRoi          *pBoundedRoi    // [out]    Pointer to ROI adjusted to source buffer boundaries
);

iwiTilePipeline_GetBoundedDstRect

Checks for image and buffer boundaries for the destination buffer and limits tile rectangle. 

IW_DECL(IppStatus) iwiTilePipeline_GetBoundedDstRoi(
    const IwiTile   *pTile,         // [in]     Pointer to the IwiTile structure
    IwiRoi          *pBoundedRoi    // [out]    Pointer to ROI adjusted to destination buffer boundaries
);

iwiTilePipeline_GetMinTileSize

Returns minimal acceptable tile size of the current pipeline. 

IW_DECL(IppStatus) iwiTilePipeline_GetMinTileSize(
    const IwiTile   *pTile,        // [in]      Pointer to the IwiTile structure
    IwiSize         *pMinTileSize  // [out]     Pointer to the minimal tile size for the current pipeline
);

Parent topic: Tiling Functions
Level Two Title