Undistortion Class Reference

Inheritance diagram for Undistortion:

Public Member Functions
	Undistortion (IntrinsicParameters intrinsicParameters)
	Constructs an undistortion using intrinsic parameters.
	Undistortion (IntrinsicParameters intrinsicParameters, Metadata metadata)
	Constructs an undistortion using intrinsic parameters and metadata.
	Undistortion (CalibrationParameters calibrationParameters)
	Constructs an undistortion using calibration parameters.
	Undistortion (CalibrationParameters calibrationParameters, Metadata metadata)
	Constructs an undistortion using calibration parameters and metadata.
void	Dispose ()
	Releases all resources used by the Undistortion.
UndistortedImage	Process (Image image)
	Applies undistortion to the specified image.

Properties
Interpolation	Interpolation [get, set]
	Gets or sets the Interpolation method used for undistortion.

Detailed Description

Represents an undistortion transformation for images.

Provides geometric correction to remove lens distortion using intrinsic calibration parameters. The intrinsic parameters can be obtained using CameraCalibration.Process().

This class also supports undistorting images with binning factors that differ from those used during calibration, as long as the image metadata includes valid binning information. The binning factor of the image to be undistorted must be greater than or equal to the binning factor of the calibration images.

Note

If the metadata of the images to be undistorted differs from the metadata used during calibration (e.g. due to different binning), internal parameters may need to be reinitialized. In such cases, the first call to Process() may take longer. To avoid this, use a constructor that accepts both calibration parameters and metadata. When using those constructors, the provided metadata must match the images to be undistorted.

Limitations

• In-place undistortion is not supported.
• Maximum supported image size is 32767 × 32767 pixels.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 52 of file Undistortion.cs.

Constructor & Destructor Documentation

Undistortion() [1/4]

Undistortion ( IntrinsicParameters intrinsicParameters )

inline

Constructs an undistortion using intrinsic parameters.

Parameters

intrinsicParameters

Intrinsic calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 64 of file Undistortion.cs.

Undistortion() [2/4]

Undistortion ( IntrinsicParameters intrinsicParameters, Metadata metadata )

inline

Constructs an undistortion using intrinsic parameters and metadata.

Parameters

intrinsicParameters	Intrinsic calibration parameters.
metadata	Metadata describing capture characteristics.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 80 of file Undistortion.cs.

Undistortion() [3/4]

Undistortion ( CalibrationParameters calibrationParameters )

inline

Constructs an undistortion using calibration parameters.

Parameters

calibrationParameters

Calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 94 of file Undistortion.cs.

Undistortion() [4/4]

Undistortion ( CalibrationParameters calibrationParameters, Metadata metadata )

inline

Constructs an undistortion using calibration parameters and metadata.

Parameters

calibrationParameters	Calibration parameters.
metadata	Metadata describing capture characteristics.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 110 of file Undistortion.cs.

Member Function Documentation

Dispose()

void Dispose ( )

inline

Releases all resources used by the Undistortion.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 142 of file Undistortion.cs.

Process()

UndistortedImage Process ( Image image )

inline

Applies undistortion to the specified image.

This function undistorts the image and returns an UndistortedImage that includes updated intrinsic parameters.

The returned image has the same size and pixel format as the input image.

Note

If the input image specifies a region, that region is also undistorted. When no region is specified (i.e., the full image is used), the output will also represent the full image.

Parameters

image

The image to be undistorted.

Returns

An undistorted image with updated intrinsic parameters.

Exceptions

IcvNotPossibleException	The image binning factor is too small for the undistortion configuration.
IcvMismatchException	The input image size or capture information does not match the undistortion configuration.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 181 of file Undistortion.cs.

Property Documentation

Interpolation

Interpolation Interpolation

getset

Gets or sets the Interpolation method used for undistortion.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 121 of file Undistortion.cs.