Intel IPP Integration Wrappers Developer Guide and Reference

ID 751823
Date 1/18/2023
Public
Document Table of Contents

iwiScale

Syntax

class IwiScaleParams: public ::IwiScaleParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiScaleParams, iwiScale_SetDefaultParams)
    IwiScaleParams(IppHintAlgorithm algoMode = ippAlgHintNone);
};
IW_DECL_CPP(IppStatus) iwiScale(
    const IwiImage         &srcImage,                  
    IwiImage               &dstImage,                 
    Ipp64f                  mulVal,                     
    Ipp64f                  addVal,                     
    const IwiScaleParams   &auxParams   = IwiScaleParams(),
    const IwiTile          &tile        = IwiTile()              
);

Parameters

srcImage

Reference to the source image.

dstImage

Reference to the destination image.

mulVal

Value of the multiplier used for scaling.

addVal

Offset value for scaling.

mode

Option to select the algorithmic implementation of the function. Supported values:

ippAlgHintNone

The algorithm is chosen by the function internal logic.

ippAlgHintFast

Fast algorithm must be used. The output results will be less accurate.

ippAlgHintAccurate

High accuracy algorithm must be used. The function will need more time for execution.

auxParams

Reference to the auxiliary parameters structure.

tile

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

Auxiliary Arguments

Argument Default Value Description

algoMode

ippAlgHintNone

Option to select the algorithmic implementation of the function.

Description

This function converts the source image from one data type to another with the specified scaling and shifting parameters. The operation is performed by the following formula: dst=saturate(src*mulVal+addVal).

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsDataTypeErr

The dataType value is illegal.

ippStsSizeErr

Values of the size fields are illegal.

ippStsInplaceModeNotSupportedErr

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

ippStsNullPtrErr

At least one of the pointers (except tile) is NULL.