Developer Reference

  • 2021
  • 03/26/2021
  • Public Content
Contents

Sqr

Squares pixel values of an image and writes them into the destination image.

Syntax

Case 1: Not-in-place operation on integer data
IppStatus ippiSqr_<mod>
(
const Ipp<datatype>*
pSrc
,
int
srcStep
,
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_C4RSfs
16u_C4RSfs
16s_C4RSfs
8u_AC4RSfs
16u_AC4RSfs
16s_AC4RSfs
Case 2: Not-in-place operation on floating-point data
IppStatus ippiSqr_<mod>
(
const Ipp32f*
pSrc
,
int
srcStep
,
Ipp32f*
pDst
,
int
dstStep
,
IppiSize
roiSize
);
Supported values for
mod
:
32f_C1R
32f_C3R
32f_C4R
32f_AC4R
Case 3: In-place operation on integer data
IppStatus ippiSqr_<mod>
(
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_C4IRSfs
16u_C4IRSfs
16s_C4IRSfs
8u_AC4IRSfs
16u_AC4IRSfs
16s_AC4IRSfs
Case 4: In-place operation on floating-point data
IppStatus ippiSqr_<mod>
(
Ipp32f*
pSrcDst
,
int
srcDstStep
,
IppiSize
roiSize
);
Supported values for
mod
:
32f_C1IR
32f_C3IR
32f_C4IR
32f_AC4IR
Case 5: Threading layer functions based on classic API
IppStatus ippiSqr_16s_C1IRSfs_T
(
Ipp16s*
pSrcDst
,
int
srcDstStep
,
IppiSize
roiSize
,
int
scaleFactor
);
IppStatus ippiSqr_16s32s_C1RSfs_T
(
const Ipp16s*
pSrc
,
int
srcStep
,
Ipp32s*
pDst
,
int
dstStep
,
IppiSize
roiSize
,
int
scaleFactor
);
Include Files
ippi.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
,
ipps.h
Libraries:
ippcore.lib
,
ippvm.lib
,
ipps.lib
Parameters
pSrc
Pointer to the source image ROI.
srcStep
Distance, in bytes, between the starting points of consecutive lines in the source image.
pDst
Pointer to the destination image ROI.
dstStep
Distance, in bytes, between the starting points 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 the starting points 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 squares pixel values of the source image ROI and writes them to the destination image ROI. The function flavors operating on integer data apply fixed scaling defined by
scaleFactor
to the internally computed values, and saturate the results before writing them to the destination image ROI.
Note that the functions with the
AC4
descriptor do not process alpha channels.
Return Values
ippStsNoErr
Indicates an error. Any other value indicates an error or a warning.
ippStsNullPtrErr
Indicates an error condition if one of the specified pointers is
NULL
.
ippStsSizeErr
Indicates an error condition if
roiSize
has a field with zero or negative value.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.