Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

UndistortRadial

Corrects radial distortions of the single image.

Syntax

IppStatus ippiUndistortRadial_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, Ipp32f fx, Ipp32f fy, Ipp32f cx, Ipp32f cy, Ipp32f k1, Ipp32f k2, Ipp8u* pBuffer);

Supported values for mod:

8u_C1R

16u_C1R

32f_C1R

8u_C3R

16u_C3R

32f_C3R

Include Files

ippcv.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h, ippi.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib, ippi.lib

Parameters

pSrc
Pointer to the ROI in the source distorted image.
srcStep
Distance in bytes between starts of consecutive lines in the source image.
pDst
Pointer to the ROI in the destination corrected image.
dstStep
Distance in bytes between starts of consecutive lines in the destination image.
roiSize
Size of source and destination images ROI in pixels.
fx
Focal lengths along the x axis.
fy
Focal lengths along the y axis.
cx
x-coordinate of the principal point.
cy
y-coordinate of the principal point.
k1
First coefficient of radial distortion.
k2
Second coefficient of radial distortion.
pBuffer
Pointer to the external buffer.

Description

This function operates with ROI (see Regions of Interest in Intel IPP).

This function corrects radial distortions of the single source image pSrc and stores corrected image in the pDst. Correction is performed accounting camera parameters fx, fy, cx, cy and radial distortion parameters k1, k2. The function can also pass the pointer to the external buffer pBuffer whose size should be computed previously using the function ippiUndistortGetSize. If a null pointer is passed, slower computations without an external buffer will be performed.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error if pSrc or pDst is NULL.

ippStsSizeErr

Indicates an error condition if roiSize has a field with zero or negative value.

ippStsStepErr

Indicates an error condition if srcStep is less than roiSize.width * <pixelSize> , or dstStep is less than roiSize.width * <pixelSize>.

ippStsNotEvenStepErr

Indicates an error condition if one of the step values is not divisible by 4 for floating-point images, or by 2 for short-integer images.

ippStsBadArgErr

Indicates an error if fx or fy is equal to 0.