DistortionCoefficients Class Reference

Inheritance diagram for DistortionCoefficients:

Public Member Functions
	DistortionCoefficients (double[] radialDistortion, double[] tangentialDistortion)
	Creates distortion coefficients from radial and tangential distortion coefficients.
	DistortionCoefficients (double[] radialDistortion, double[] tangentialDistortion, double[] prismDistortion)
	Creates distortion coefficients from radial, tangential and prism distortion coefficients.
	DistortionCoefficients (double[] radialDistortion, double[] tangentialDistortion, double[] prismDistortion, double[] tiltDistortion)
	Creates distortion coefficients from radial, tangential, prism and tilt distortion coefficients.
bool	Equals (DistortionCoefficients? other)
	Compares the distortion coefficients by value.
override bool	Equals (object? other)
	Compares the distortion coefficients by value.
override int	GetHashCode ()
	Generates a hash code from the coefficients.
override string	ToString ()
	Returns a string representation of the distortion coefficients.

Static Public Attributes
const int	RadialDistortionMaxElements = 6
	Maximum number of radial distortion coefficients.
const int	TangentialDistortionMaxElements = 2
	Maximum number of tangential distortion coefficients.
const int	PrismDistortionMaxElements = 4
	Maximum number of prism distortion coefficients.
const int	TiltDistortionMaxElements = 2
	Maximum number of tilt distortion coefficients.

Properties
double[]	PrismDistortion [get]
	Provides the prism distortion.
double[]	RadialDistortion [get]
	Provides the radial distortion.
double[]	TangentialDistortion [get]
	Provides the tangential distortion.
double[]	TiltDistortion [get]
	Provides the tilt distortion.

Detailed Description

Holds lens distortion coefficients.

Contains coefficients used to model and correct optical distortions introduced by real-world lenses. These coefficients are typically estimated during camera calibration and are used for image undistortion or improving projection accuracy.

The distortion model includes:

• RadialDistortion: Radial distortion causes straight lines to appear curved, especially near the image edges. The effect increases with distance from the optical center.
• TangentialDistortion: Tangential distortion results from lens decentering, where the lens is not perfectly aligned with the optical axis. This causes image points to be displaced perpendicular to the radial direction.
• PrismDistortion: Prism distortion introduces asymmetrical warping due to optical elements such as prisms or tilted glass plates. This distortion leads to non-uniform displacement that cannot be captured by purely radial models.
• TiltDistortion: Tilt distortion occurs when the lens is tilted relative to the image plane, introducing a global projective distortion that skews the overall image geometry.

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

DistortionCoefficients() [1/3]

DistortionCoefficients ( double[] radialDistortion, double[] tangentialDistortion )

inline

Creates distortion coefficients from radial and tangential distortion coefficients.

Parameters

radialDistortion	The radial distortion coefficients.
tangentialDistortion	The tangential distortion coefficients.

Exceptions

IcvNotPossibleException

One or multiple of the given arrays have the wrong size.

Since

IDSImaging.Peak.ICV 1.3

DistortionCoefficients() [2/3]

DistortionCoefficients ( double[] radialDistortion, double[] tangentialDistortion, double[] prismDistortion )

inline

Creates distortion coefficients from radial, tangential and prism distortion coefficients.

Parameters

radialDistortion	The radial distortion coefficients.
tangentialDistortion	The tangential distortion coefficients.
prismDistortion	The prism distortion coefficients.

Exceptions

IcvNotPossibleException

One or more arrays have an invalid size.

Since

IDSImaging.Peak.ICV 1.3

DistortionCoefficients() [3/3]

DistortionCoefficients ( double[] radialDistortion, double[] tangentialDistortion, double[] prismDistortion, double[] tiltDistortion )

inline

Creates distortion coefficients from radial, tangential, prism and tilt distortion coefficients.

Parameters

radialDistortion	The radial distortion coefficients.
tangentialDistortion	The tangential distortion coefficients.
prismDistortion	The prism distortion coefficients.
tiltDistortion	The tilt distortion coefficients.

Exceptions

IcvNotPossibleException

One or more arrays have an invalid size.

Since

IDSImaging.Peak.ICV 1.3

Member Function Documentation

Equals() [1/2]

bool Equals ( DistortionCoefficients? other )

inline

Compares the distortion coefficients by value.

Since

IDSImaging.Peak.ICV 1.3

Equals() [2/2]

override bool Equals ( object? other )

inline

Compares the distortion coefficients by value.

Since

IDSImaging.Peak.ICV 1.3

GetHashCode()

override int GetHashCode ( )

inline

Generates a hash code from the coefficients.

Since

IDSImaging.Peak.ICV 1.3

ToString()

override string ToString ( )

inline

Returns a string representation of the distortion coefficients.

Since

IDSImaging.Peak.ICV 1.3

Field Documentation

PrismDistortionMaxElements

const int PrismDistortionMaxElements = 4

static

Maximum number of prism distortion coefficients.

Since

IDSImaging.Peak.ICV 1.3

RadialDistortionMaxElements

const int RadialDistortionMaxElements = 6

static

Maximum number of radial distortion coefficients.

Since

IDSImaging.Peak.ICV 1.3

TangentialDistortionMaxElements

const int TangentialDistortionMaxElements = 2

static

Maximum number of tangential distortion coefficients.

Since

IDSImaging.Peak.ICV 1.3

TiltDistortionMaxElements

const int TiltDistortionMaxElements = 2

static

Maximum number of tilt distortion coefficients.

Since

IDSImaging.Peak.ICV 1.3

Property Documentation

PrismDistortion

double [] PrismDistortion

get

Provides the prism distortion.

Since

IDSImaging.Peak.ICV 1.3

RadialDistortion

double [] RadialDistortion

get

Provides the radial distortion.

Since

IDSImaging.Peak.ICV 1.3

TangentialDistortion

double [] TangentialDistortion

get

Provides the tangential distortion.

Since

IDSImaging.Peak.ICV 1.3

TiltDistortion

double [] TiltDistortion

get

Provides the tilt distortion.

Since

IDSImaging.Peak.ICV 1.3