Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiSubC

Syntax

class IwiSubCParams: public ::IwiSubCParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiSubCParams, iwiSubC_SetDefaultParams)
    IwiSubCParams(int _scaleFactor = 0, IwiChDescriptor _chDesc = iwiChDesc_None);
};
IW_DECL_CPP(IppStatus) iwiSubC(
    IwValueFloat         values,                       
    const IwiImage      &srcImage,                     
    IwiImage            &dstImage,                     
    const IwiSubCParams &auxParams  = IwiSubCParams(),  
    const IwiTile       &tile       = IwiTile()         
)

Parameters

values

Reference to the array containing values to subtract from the source image: one element for each channel.

srcImage

Reference to the image from which the values are subtracted.

dstImage

Reference to the resulting image (can be the same as srcImage).

auxParams

Reference to the auxiliary parameters structure.

tile

Reference to the IwiTile structure for tiling. By default, no tiling is applied.

Auxiliary Arguments

Argument Default Value Description

scaleFactor

0

Scale factor.

chDesc

iwiChDesc_None

Special channels processing mode.

Description

This function subtracts a constant from an image and puts the result to dstImage.

This function supports the following features:

Feature Support
In-place mode Yes
64-bit sizes Yes
Internal threading No
Manual tiling Yes
IwsTile simple tiling Yes
IwsTile pipeline tiling Yes

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The value for channels is illegal.

ippStsSizeErr

Values for size fields are illegal.

ippStsNullPtrErr

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