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 IwiImage IwiTile IwiBorderSize _IwiChDescriptor 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

Image Processing Structures

IwiImage

The IwiImage is a base structure for IW image processing functions. This structure stores input and output data. 

typedef struct _IwiImage
{
    void          *m_pBuffer;      // Pointer to the image buffer. Should NULL for any external buffer.
    void          *m_ptr;          // Pointer to the start of actual image data.
    IwSize         m_step;         // Distance, in bytes, between the starting points of consecutive lines in the source image memory.
    IwiSize        m_size;         // Image size, in pixels.
    IppDataType    m_dataType;     // Image pixel type.
    int            m_typeSize;     // Size of image pixel type, in bytes.
    int            m_channels;     // Number of image channels.
    IwiBorderSize  m_inMemSize;    // Memory border size around image data.
} IwiImage;

IwiTile

The IwiTile structure is a main structure for semi-automatic tiling operations. This structure provides main context for tiling across IW API and contains mostly values for complex pipelines tiling. 

typedef struct _IwiTile
{
    IwiRoi            m_srcRoi;            // Absolute ROI for the source image
    IwiRoi            m_dstRoi;            // Absolute ROI for the destination image

    IwiPoint          m_untaintSrcPos;     // Absolute unaligned source ROI position
    IwiPoint          m_untaintDstPos;     // Absolute unaligned destination ROI position

    IwiRoi            m_boundSrcRoi;       // Relative ROI for the source image bounded to the buffer
    IwiRoi            m_boundDstRoi;       // Relative ROI for the destination image bounded to the buffer

    IwiSize           m_srcBufferSize;     // Actual source buffer size
    IwiSize           m_dstBufferSize;     // Actual destination buffer size

    IwiSize           m_srcImageSize;      // Full source image size
    IwiSize           m_dstImageSize;      // Full destination image size

    IwiSize           m_srcExImageSize;    // Source image size extended on parent InMem border size
    IwiSize           m_dstExImageSize;    // Destination image size extended on parent InMem border size

    IwiSize           m_maxTileSize;       // Maximum tile size

    IwiBorderType     m_borderType;        // Type of source image border
    IwiBorderSize     m_borderSize;        // Border required for the current operation
    IwiBorderSize     m_borderSizeAcc;     // Accumulated border size for current and parent operations
    IwiBorderSize     m_externalMem;       // Amount of memory required to process InMem border for current edge tile
    IwiBorderSize     m_externalMemAcc;    // Amount of memory required to process InMem border for all edge tiles

    IwiTileTransform  m_transformStruct;   // Transformation proxy functions and data structure

    int               m_initialized;       // Internal initialization states

    struct _IwiTile  *m_pChild;            // Next Tile in the pipeline
    struct _IwiTile  *m_pParent;           // Previous Tile in the pipeline

} IwiTile;

IwiBorderSize

The IwiBorderSize structure stores border sizes for image processing functions. 

typedef struct {
    IwSize left;
    IwSize top;
    IwSize right;
    IwSize bottom;
} IwiBorderSize;

_IwiChDescriptor

The special channel descriptor _IwiChDescriptor specifies how to process non-standard channels configurations.

  • If the descriptor is not supported, the library returns an error.
  • If the descriptor is for different channels number, the library ignores it. 
typedef enum _IwiChDescriptor
{
    iwiChDesc_None    = 0,          // Process all channels

    // C4 descriptors
    iwiChDesc_C4M1110 = 0x00004007, // Process only the first 3 channels as RGB. Equivalent to AC4 functions from the main Intel(R) IPP library.
    iwiChDesc_C4M1000 = 0x00004001, // Process only the first channel as gray-scale.
    iwiChDesc_C4M1001 = 0x00004009, // Process only the first channel and the last channel as gray-scale with alpha.
    iwiChDesc_C4M1XX0 = 0x00064001, // Process only the first channel as gray-scale and replicate it to remaining color channels.
    iwiChDesc_C4M1XX1 = 0x00064009  // Process only the first channel and the last channel as gray-scale with alpha and replicate gray-scale to remaining color channels.

} IwiChDescriptor;

Parent topic: Image Processing
Level Two Title

Did you find the information on this page useful?

Characters remaining:

Feedback Message