iwiSub
Syntax
class IwiSubParams: public ::IwiSubParams
{
public:
IW_BASE_PARAMS_CONSTRUCTORS(IwiSubParams, iwiSub_SetDefaultParams)
IwiSubParams(int _scaleFactor = 0, IwiChDescriptor _chDesc = iwiChDesc_None);
};IW_DECL_CPP(IppStatus) iwiSub(
const IwiImage &src1Image,
const IwiImage &src2Image,
IwiImage &dstImage,
const IwiSubParams &auxParams = IwiSubParams(),
const IwiTile &tile = IwiTile()
)Parameters
- src1Image
- Reference to the image to be subtracted from another image.
- src2Image
- Reference to the image from which thesrc1Imageis subtracted.
- dstImage
- Reference to the resulting image (can be the same assrc2Image).
- auxParams
- Reference to the auxiliary parameters structure.
- tile
- Reference to theIwiTilestructure for tiling. Be 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 one source image from another 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
- ThedataTypevalue is illegal.
- ippStsNumChannelsErr
- The value for channels is illegal.
- ippStsSizeErr
- Values for size fields are illegal.
- ippStsNullPtrErr
- At least one of the references (excepttile) isNULL.