Intel® Integrated Performance Primitives Developer Reference

Developer Reference

  • 2020
  • 07/15/2020
  • Public Content
Contents

CopyConstBorder

Copies pixel values between two 3D images and adds border pixels with a constant value.

Syntax

IppStatus ipprCopyConstBorder_8u_C1V(const Ipp8u*
pSrc
, int
srcPlaneStep
, int
srcStep
, IpprVolume
srcRoiVolume
, Ipp8u*
pDst
, int
dstPlaneStep
, int
dstStep
, IpprVolume
dstRoiVolume
, int
topBorderHeight
, int
leftBorderWidth
, int
forwardBorderDepth
, const Ipp8u*
value
);
IppStatus ipprCopyConstBorder_16u_C1V(const Ipp16u*
pSrc
, int
srcPlaneStep
, int
srcStep
, IpprVolume
srcRoiVolume
, Ipp16u*
pDst
, int
dstPlaneStep
, int
dstStep
, IpprVolume
dstRoiVolume
, int
topBorderHeight
, int
leftBorderWidth
, int
forwardBorderDepth
, const Ipp16u*
value
);
IppStatus ipprCopyConstBorder_16s_C1V(const Ipp16s*
pSrc
, int
srcPlaneStep
, int
srcStep
, IpprVolume
srcRoiVolume
, Ipp16s*
pDst
, int
dstPlaneStep
, int
dstStep
, IpprVolume
dstRoiVolume
, int
topBorderHeight
, int
leftBorderWidth
, int
forwardBorderDepth
, const Ipp16s*
value
);
IppStatus ipprCopyConstBorder_32f_C1V(const Ipp32f*
pSrc
, int
srcPlaneStep
, int
srcStep
, IpprVolume
srcRoiVolume
, Ipp32f*
pDst
, int
dstPlaneStep
, int
dstStep
, IpprVolume
dstRoiVolume
, int
topBorderHeight
, int
leftBorderWidth
, int
forwardBorderDepth
, const Ipp32f*
value
);
IppStatus ipprCopyConstBorder_64f_C1V(const Ipp64f*
pSrc
, int
srcPlaneStep
, int
srcStep
, IpprVolume
srcRoiVolume
, Ipp64f*
pDst
, int
dstPlaneStep
, int
dstStep
, IpprVolume
dstRoiVolume
, int
topBorderHeight
, int
leftBorderWidth
, int
forwardBorderDepth
, const Ipp64f*
value
);
Platform-aware functions
IppStatus ipprCopyConstBorder_8u_C1V_L(const Ipp8u*
pSrc
, IppSizeL
srcPlaneStep
, IppSizeL
srcStep
, IpprVolumeL
srcRoiVolume
, Ipp8u*
pDst
, IppSizeL
dstPlaneStep
, IppSizeL
dstStep
, IpprVolumeL
dstRoiVolume
, IppSizeL
topBorderHeight
, IppSizeL
leftBorderWidth
, IppSizeL
forwardBorderDepth
, const Ipp8u*
value
);
IppStatus ipprCopyConstBorder_16u_C1V_L(const Ipp16u*
pSrc
, IppSizeL
srcPlaneStep
, IppSizeL
srcStep
, IpprVolumeL
srcRoiVolume
, Ipp16u*
pDst
, IppSizeL
dstPlaneStep
, IppSizeL
dstStep
, IpprVolumeL
dstRoiVolume
, IppSizeL
topBorderHeight
, IppSizeL
leftBorderWidth
, IppSizeL
forwardBorderDepth
, const Ipp16u*
value
);
IppStatus ipprCopyConstBorder_16s_C1V_L(const Ipp16s*
pSrc
, IppSizeL
srcPlaneStep
, IppSizeL
srcStep
, IpprVolumeL
srcRoiVolume
, Ipp16s*
pDst
, IppSizeL
dstPlaneStep
, IppSizeL
dstStep
, IpprVolumeL
dstRoiVolume
, IppSizeL
topBorderHeight
, IppSizeL
leftBorderWidth
, IppSizeL
forwardBorderDepth
, const Ipp16s*
value
);
IppStatus ipprCopyConstBorder_32f_C1V_L(const Ipp32f*
pSrc
, IppSizeL
srcPlaneStep
, IppSizeL
srcStep
, IpprVolumeL
srcRoiVolume
, Ipp32f*
pDst
, IppSizeL
dstPlaneStep
, IppSizeL
dstStep
, IpprVolumeL
dstRoiVolume
, IppSizeL
topBorderHeight
, IppSizeL
leftBorderWidth
, IppSizeL
forwardBorderDepth
, const Ipp32f*
value
);
IppStatus ipprCopyConstBorder_64f_C1V_L(const Ipp64f*
pSrc
, IppSizeL
srcPlaneStep
, IppSizeL
srcStep
, IpprVolumeL
srcRoiVolume
, Ipp64f*
pDst
, IppSizeL
dstPlaneStep
, IppSizeL
dstStep
, IpprVolumeL
dstRoiVolume
, IppSizeL
topBorderHeight
, IppSizeL
leftBorderWidth
, IppSizeL
forwardBorderDepth
, const Ipp64f*
value
);
Include Files
ippi.h
ippi_l.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
,
ipps.h
Libraries:
ippcore.lib
,
ippvm.lib
,
ipps.lib
Parameters
pSrc
Array of pointers to the planes in the source volume.
srcStep
Distance, in bytes, between the starting points of consecutive lines in each plane of the source volume.
srcPlaneStep
Distance, in bytes, between the starting points of consecutive images in every plane of the source volume.
srcRoiVolume
Volume of the source ROI in pixels.
pDst
Array of pointers to the planes in the destination volume.
dstStep
Distance, in bytes, between the starting points of consecutive lines in each plane of the destination volume.
dstPlaneStep
Distance, in bytes, between the starting points of consecutive images in every plane of the source volume.
dstRoiVolume
Volume of the destination ROI in pixels.
topBorderHeight
Height of the top border in pixels.
leftBorderWidth
Width of the left border in pixels.
forwardBorderDepth
Depth of the forward border in pixels.
value
Constant value to assign to the border pixels.
Description
This function operates with VOI. This function copies the source image
pSrc
 with the volume
srcRoiVolume
 to the destination image
pDst
 with the volume
dstRoiVolume
 and creates a border outside the copied area. The function sets pixel values of the border to the specified constant value that is passed by the
value
 argument.
The image below shows the mapping of the parameters
topBorderHeight
,
leftBorderWidth
, and
forwardBorderDeprh
 onto the dimensions of the three-dimensional space.
Mapping the border parameters onto the dimensions of the 3D space.
Return Values
ippStsNullPtrErr
Indicates an error condition if
pSrc
,
pDst
, or
value
 pointer is
NULL
.
ippStsStepErr
Indicates an error condition if
srcPlaneStep
,
srcStep
,
dstPlaneStep
, or
dstStep
 has a field with negative value.
ippStsSizeErr
Indicates an error condition if
leftBorderWidth
,
topBorderHeight
, or
forwardBorderDepth
 has a field with negative value.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804