Sub
Subtracts pixel values of two images.
Syntax
Case 1: Not-in-place operation on integer or complex
data
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
int
src1Step
,
const Ipp<datatype>*
pSrc2
,
int
src2Step
,
Ipp<datatype>*
pDst
,
int
dstStep
,
IppiSize
roiSize
,
int
scaleFactor
);
Supported values for
mod
8u_C1RSfs | 16u_C1RSfs | 16s_C1RSfs |
8u_C3RSfs | 16u_C3RSfs | 16s_C3RSfs |
8u_AC4RSfs | 16u_AC4RSfs | 16s_AC4RSfs |
8u_C4RSfs | 16u_C4RSfs | 16s_C4RSfs |
Case 2: Not-in-place operation on floating-point or
complex data
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
int
src1Step
,
const Ipp<datatype>*
pSrc2
,
int
src2Step
,
Ipp<datatype>*
pDst
,
int
dstStep
,
IppiSize
roiSize
);
Supported values for
mod
:32f_C1R |
32f_C3R |
32f_AC4R |
32f_C4R |
Case 3: In-place operation on integer or complex
data
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc
,
int
srcStep
,
Ipp<datatype>*
pSrcDst
,
int
srcDstStep
,
IppiSize
roiSize
,
int
scaleFactor
);
Supported values for
mod
:8u_C1IRSfs | 16u_C1IRSfs | 16s_C1IRSfs |
8u_C3IRSfs | 16u_C3IRSfs | 16s_C3IRSfs |
8u_AC4IRSfs | 16u_AC4IRSfs | 16s_AC4IRSfs |
8u_C4IRSfs | 16u_C4IRSfs | 16s_C4IRSfs |
Case 4: In-place operation on floating-point or
complex data
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc
,
int
srcStep
,
Ipp<datatype>*
pSrcDst
,
int
srcDstStep
,
IppiSize
roiSize
);
Supported values for
mod
:32f_C1IR |
32f_C3IR |
32f_AC4IR |
32f_C4IR |
Case 5: Not-in-place operation on integer data with
platform-aware functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
const Ipp<datatype>*
pSrc2
,
IppSizeL
src2Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
,
int
scaleFactor
);
Supported values for
mod
:8u_C1RSfs_L | 16u_C1RSfs_L | 16s_C1RSfs_L |
8u_C3RSfs_L | 16u_C3RSfs_L | 16s_C3RSfs_L |
8u_AC4RSfs_L | 16u_AC4RSfs_L | 16s_AC4RSfs_L |
8u_C4RSfs_L | 16u_C4RSfs_L | 16s_C4RSfs_L |
Case 6: Not-in-place operation on floating-point data
with platform-aware functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
const Ipp<datatype>*
pSrc2
,
IppSizeL
src2Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
);
Supported values for
mod
:32f_C1R_L |
32f_C3R_L |
32f_C4R_L |
32f_AC4R_L |
Case 7: In-place operation on integer data with
platform-aware functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc
,
IppSizeL
srcStep
,
Ipp<datatype>*
pSrcDst
,
IppSizeL
srcDstStep
,
IppiSizeL
roiSize
,
int
scaleFactor
);
Supported values for
mod
:8u_C1IRSfs_L | 16u_C1IRSfs_L | 16s_C1IRSfs_L |
8u_C3IRSfs_L | 16u_C3IRSfs_L | 16s_C3IRSfs_L |
8u_AC4IRSfs_L | 16u_AC4IRSfs_L | 16s_AC4IRSfs_L |
8u_C4IRSfs_L | 16u_C4IRSfs_L | 16s_C4IRSfs_L |
Case 8: In-place operation on floating-point data with
platform-aware functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
);
Supported values for
mod
:32f_C1IR_L |
32f_C3IR_L |
32f_AC4IR_L |
32f_C4IR_L |
Case 9: Not-in-place operation on integer data with
threading layer (TL) functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
const Ipp<datatype>*
pSrc2
,
IppSizeL
src2Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
,
int
scaleFactor
);
Supported values for
mod
:8u_C1RSfs_LT | 16u_C1RSfs_LT | 16s_C1RSfs_LT |
8u_C3RSfs_LT | 16u_C3RSfs_LT | 16s_C3RSfs_LT |
8u_AC4RSfs_LT | 16u_AC4RSfs_LT | 16s_AC4RSfs_LT |
8u_C4RSfs_LT | 16u_C4RSfs_LT | 16s_C4RSfs_LT |
Case 10: Not-in-place operation on floating-point data
with TL functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
const Ipp<datatype>*
pSrc2
,
IppSizeL
src2Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
);
Supported values for
mod
:32f_C1R_LT |
32f_C3R_LT |
32f_C4R_LT |
32f_AC4R_LT |
Case 11: In-place operation on integer data with TL
functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc
,
IppSizeL
srcStep
,
Ipp<datatype>*
pSrcDst
,
IppSizeL
srcDstStep
,
IppiSizeL
roiSize
,
int
scaleFactor
);
Supported values for
mod
:8u_C1IRSfs_LT | 16u_C1IRSfs_LT | 16s_C1IRSfs_LT |
8u_C3IRSfs_LT | 16u_C3IRSfs_LT | 16s_C3IRSfs_LT |
8u_AC4IRSfs_LT | 16u_AC4IRSfs_LT | 16s_AC4IRSfs_LT |
8u_C4IRSfs_LT | 16u_C4IRSfs_LT | 16s_C4IRSfs_LT |
Case 12: In-place operation on floating-point data
with TL functions
IppStatus ippiSub_<mod>
(
const Ipp<datatype>*
pSrc1
,
IppSizeL
src1Step
,
Ipp<datatype>*
pDst
,
IppSizeL
dstStep
,
IppiSizeL
roiSize
);
Supported values for
mod
:32f_C1IR_LT |
32f_C3IR_LT |
32f_AC4IR_LT |
32f_C4IR_LT |
Include Files
ippi.h
Flavors with the
_LT
suffix: ippi_tl.h
Flavors with the
_L
suffix: ippi_l.h
Domain Dependencies
Flavors declared in
ippi.h
:Headers:
ippcore.h
, ippvm.h
, ipps.h
Libraries:
ippcore.lib
, ippvm.lib
, ipps.lib
Flavors declared in
ippi_tl.h
:Libraries:
ippcore.lib
, ippvm.lib
, ipps.lib
, ippi.lib
, ippcore_tl.lib
, ippi_tl.lib
Parameters
- pSrc,pSrc1,pSrc2
- Pointers to the source images ROI.
- srcStep,src1Step,src2Step
- Distances in bytes between starts of consecutive lines in the source images.
- pDst
- Pointer to the destination image ROI.
- dstStep
- Distance in bytes between starts of consecutive lines in the destination image.
- pSrcDst
- Pointer to the source and destination image ROI for the in-place operation.
- srcDstStep
- Distance in bytes between starts of consecutive lines in the source and destination image for the in-place operation.
- roiSize
- Size of the source and destination ROI in pixels.
- scaleFactor
- Scale factor (see Integer Result Scaling).
Description
This function operates with ROI (see Regions of Interest in Intel
IPP).
This function subtracts pixel values of the source buffer
pSrc1
from the
corresponding pixel values of the buffer pSrc2
and places the result in
the destination buffer pDst
. For in-place operations, the values in pSrc
are subtracted from the
values in pSrcDst
and
the results are placed into pSrcDst
. For complex data, the function processes both real and
imaginary parts of pixel values. Step values must be positive for functions that operate
on complex data.
In case of operations on integer data, the resulting values are
scaled by
scaleFactor
.Note that the functions with
AC4
descriptor do not process alpha channels.Return Values
- ippStsNoErr
- Indicates no error. Any other value indicates an error or a warning.
- ippStsNullPtrErr
- Indicates an error condition if one of the specified pointers isNULL.
- ippStsSizeErr
- Indicates an error condition ifroiSizehas a field with zero or negative value.
- ippStsStepErr
- Indicates an error condition if any of the specified buffer step values is zero or negative for functions that operate on complex data.