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 IwException IwValue iwTypeToSize iwTypeIsFloat iwTypeGetMin iwTypeGetMax iwTypeGetRange iwValueSaturate iwValueRelToAbs IwTls IwSetCpuFeaturesRegion IppiPoint 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

Core Functionality

IwException

Stores an error code value for an exception returned by the function. 

class IwException
{
public:
    // Constructor with status assignment
    IwException(
        IppStatus status    // Intel IPP status value
    );
    // Default destructor
    ~IwException() {}

    // IwException to IppStatus cast operator
    inline operator IppStatus() const;

    IppStatus m_status; // Stored Intel IPP status value
};

IwValue

Stores values for an array for array type casting

For more information on Ipp32s, see:

  • Data Types (Intel® Integrated Performance Primitives for Intel® Architecture Developer Reference. Volume 1: Signal and Data Processing)
  • Data Types (Intel® Integrated Performance Primitives for Intel® Architecture Developer Reference. Volume 2: Image Processing)
  • Data Types (Intel® Integrated Performance Primitives Theory of Operation) 

template<typename DST>
class IwValue
{
public:
    // Default constructor. Sets an array to zero.
    IwValue();

    // Uniform template-based constructor. Sets channels to one value.
    template<typename SRC>
    IwValue(SRC valUniform);

    // 3-channel template-based constructor. Sets channels to individual values.
    template<typename SRC>
    IwValue(SRC valC1, SRC valC2, SRC valC3);

    // 4-channel template-based constructor. Sets channels to individual values.
    template<typename SRC>
    IwValue(SRC valC1, SRC valC2, SRC valC3, SRC valC4);

    // Buffer template-based constructor. Sets values from a buffer of a specific type.
    template<typename SRC>
    IwValue(SRC *pBuffer, unsigned int channels);

    // Buffer parameter-based constructor. Sets values from a buffer of a specific type.
    IwValue(void *pBuffer, IppDataType type, unsigned int channels);

    // Uniform template setter. Sets channels to one value.
    template<typename SRC>
    void SetValue(SRC valUniform);

    // 3-channel template setter. Sets channels to individual values.
    template<typename SRC>
    void SetValue(SRC valC1, SRC valC2, SRC valC3);

    // 4-channel template setter. Sets channels to individual values.
    template<typename SRC>
    void SetValue(SRC valC1, SRC valC2, SRC valC3, SRC valC4);

    // Buffer template-based setter. Sets values from a buffer of a specific type.
    template<typename SRC>
    void SetValue(SRC *pBuffer, unsigned int channels);

    // Buffer parameter-based setter. Sets values from a buffer of a specific type.
    void SetValue(void *pBuffer, IppDataType type, unsigned int channels);

    // Returns number of initialized values.
    int ValuesNum() const;

    // IwValue to the Ipp64f cast operator.
    inline operator       DST  () const;

    // IwValue to the Ipp64f* cast operator.
    inline operator       DST* () const;

    // IwValue to the const Ipp64f* cast operator.
    inline operator const DST* () const;

private:
    int    m_values;  // Number of initialized values.
    DST    m_val[4];  // Reserve 4 channels.
};

typedef IwValue<Ipp64f> IwValueFloat;
typedef IwValue<Ipp32s> IwValueInt;

iwTypeToSize

Converts IppDataType to actual length, in bytes. Returns the size of IppDataType, in bytes. 

IW_DECL_CPP(int) iwTypeToSize(
    IppDataType type    // Data type
);

iwTypeIsFloat

Returns 1 if data type is of float type, and 0 otherwise. 

IW_DECL_CPP(int) iwTypeIsFloat(
    IppDataType type    // Data type
);

iwTypeGetMin

Returns minimum possible value for the specified data type. 

IW_DECL_CPP(double) iwTypeGetMin(
    IppDataType type    // Data type for min value
);

iwTypeGetMax

Returns maximum possible value for the specified data type. 

IW_DECL_CPP(double) iwTypeGetMax(
    IppDataType type    // Data type for max value
);

iwTypeGetRange

Returns the range of values for the specified data type. 

IW_DECL_CPP(double) iwTypeGetRange(
    IppDataType type    // Data type for a range value
);

iwValueSaturate

Casts double value to input type with rounding and saturation. 

IW_DECL_CPP(double) iwValueSaturate(
    double      val,    // Input value
    IppDataType dstType // Data type for a saturation range
);

iwValueRelToAbs

Converts a relative value in range of [0, 1] to an absolute value according the specified type. 

IW_DECL_CPP(double) iwValueRelToAbs(
    double      val,    // Relative value. From 0 to 1.
    IppDataType type    // Data type for the absolute range
)

IwTls

Template-based TLS abstraction layer class. 

// Template-based TLS abstraction layer class.
// This is an extention of C IwTls structure with automatic objects destruction
template<class TYPE>
class IwTls: private ::IwTls
{
public:
    // Default constructor
    IwTls();

    // Default destructor
    ~IwTls();

    // Allocates an object for a current thread and returns a pointer to it
    TYPE* Create();

    // Releases an object for a current thread
    void Release();

    // Releases objects for all threads
    void ReleaseAll();

    // Returns pointer to an object for a current thread
    TYPE* Get() const;

private:
    // Object destructor
    static void __STDCALL TypeDestructor(void *pData);
};

IwSetCpuFeaturesRegion

Sets Intel IPP optimizations for the current region and restores the original optimizations at the end of the region. 

// This class sets Intel IPP optimizations for the current region and restores previous optimizations at the region end
class IwSetCpuFeaturesRegion
{
public:
    // Default constructor. Saves current enabled CPU features.
    IwSetCpuFeaturesRegion();

    // Saves current enabled CPU features and sets new features mask.
    IwSetCpuFeaturesRegion(Ipp64u featuresMask);

    // Sets new features mask for the region.
    IppStatus Set(Ipp64u featuresMask);

    // Default destructor. Restores saved features mask.
    ~IwSetCpuFeaturesRegion();

private:
    Ipp64u m_stored;
};

IppiPoint

For information about IppiPoint, see Structures and Enumerators in the Intel® Integrated Performance Primitives Developer Guide and Reference.

Parent topic: C++ Reference
Level Two Title