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 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

class IwiWarpAffine

The IwiWarpAffine class consists of the following WarpAffine operation methods:

IwiWarpAffine()

Default constructor. 

IwiWarpAffine();

IwiWarpAffine() with Initialization

Default constructor with initialization. 

IwiWarpAffine(
        IwSize                     srcSize,                               
        IwSize                     dstSize,                             
        IppDataType                dataType,                             
        int                        channels,                               
        const double               coeffs[2][3],                           
        IppiWarpDirection          direction,                              
        IppiInterpolationType      interpolation,                          
        const IwiWarpAffineParams &params      = IwiWarpAffineParams(),    
        const IwiBorderType       &border      = ippBorderRepl
    );
Parameters

srcSize

Size of the source image, in pixels.

dstSize

Size of the destination image, in pixels.

dataType

Image pixel type.

channels

Number of image channels.

coeffs[2][3]

Coefficients for the affine transform.

direction

Transformation direction.

interpolation

Interpolation method. Supported values: ippNearest, ippLinear, ippCubic.

params

Optional parameters.

border

Extrapolation algorithm for out of image pixels processing. Supported values: ippBorderConst, ippBorderRepl, ippBorderTransp, ippBorderInMem.

Exception Values

ippStsWarpDirectionErr

The direction value is illegal.

ippStsCoeffErr

Affine transformation is singular.

ippStsInterpolationErr

The interpolation value is illegal.

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The channels value is illegal.

ippStsBorderErr

The border value is illegal.

ippStsNotSupportedModeErr

Specified combination of parameters' values is not supported.

ippStsNoMemErr

Failed to allocate memory.

ippStsSizeErr

Values of the srcSize and/or dstSize fields are illegal.

ippStsNullPtrErr

At least one of the pointers is NULL.

InitAlloc()

Method to allocate and initialize the internal data structure. 

IppStatus InitAlloc(
        IwSize                     srcSize,                               
        IwSize                     dstSize,                                
        IppDataType                dataType,                               
        int                        channels,                               
        const double               coeffs[2][3],                          
        IppiWarpDirection          direction,                            
        IppiInterpolationType      interpolation,                         
        const IwiWarpAffineParams &params      = IwiWarpAffineParams(),    
        const IwiBorderType       &border      = ippBorderRepl
    );
Parameters

srcSize

Size of the source image, in pixels.

dstSize

Size of the destination image, in pixels.

dataType

Image pixel type.

channels

Number of image channels.

coeffs[2][3]

Coefficients for the affine transform.

direction

Transformation direction.

interpolation

Interpolation method. Supported values: ippNearest, ippLinear, ippCubic.

params

Optional parameters.

border

Extrapolation algorithm for out of image pixels processing. Supported values: ippBorderConst, ippBorderRepl, ippBorderTransp, ippBorderInMem.

Exception Values

ippStsWarpDirectionErr

The direction value is illegal.

ippStsCoeffErr

Affine transformation is singular.

ippStsInterpolationErr

The interpolation value is illegal.

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The channels value is illegal.

ippStsBorderErr

The border value is illegal.

ippStsNotSupportedModeErr

Specified combination of parameters' values is not supported.

ippStsNoMemErr

Failed to allocate memory.

ippStsSizeErr

Values of the srcSize and/or dstSize fields are illegal.

ippStsNullPtrErr

At least one of the pointers is NULL.

Return Values

ippStsNoErr

No errors.

ippStsNoOperation

Warning: width and/or height of the image is equal to zero.

ippStsWrongIntersectQuad

Warning: transformed source image has no intersection with the destination image.

operator()

Method to perform the warp affine transformation on the specified image ROI. 

    IppStatus operator()(
        const IwiImage &srcImage,    
        IwiImage       &dstImage,   
        const IwiTile  &tile = IwiTile()     
    );
Parameters

pSrcImage

Reference to the source image.

pDstImage

Reference to the destination image.

tile

 Reference to the IwiTile object for tiling. By default, no tiling is used.
Exception Values

ippStsInterpolationErr

The interpolation value is illegal.

ippStsDataTypeErr

The dataType value is illegal.

ippStsBorderErr

The border value is illegal.

ippStsNumChannelsErr

The channels value is illegal.

ippStsNotEvenStepErr

The srcStep and/or dstStep value is not divisible by size of elements.

ippStsNotSupportedModeErr

Specified combination of parameters' values is not supported.

ippStsNoMemErr

Failed to allocate memory.

ippStsNullPtrErr

At least one of the pointers is NULL.

ippStsSizeErr

Values of the srcSize and/or dstSize fields are illegal.

Return Values

ippStsNoErr

No errors.

ippStsNoOperation

Warning: width and/or height of the image is equal to zero.

ippStsWrongIntersectQuad

Warning: transformed source image has no intersection with the destination image.

~IwiWarpAffine()

Default destructor. 

     ~IwiWarpAffine();

Parent topic: WarpAffine
Level Two Title