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

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

◆ 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

◆ Undistortion() [3/4]

Undistortion ( CalibrationParameters calibrationParameters )

inline

Constructs an undistortion using calibration parameters.

Parameters

calibrationParameters Calibration parameters.

Since: IDSImaging.Peak.ICV 1.3

◆ 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

Member Function Documentation

◆ Dispose()

void Dispose ( )

inline

Releases all resources used by the Undistortion.

Since: IDSImaging.Peak.ICV 1.3

◆ 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.

The image region is also undistorted.

Note: In the rare case that the Metadata ROI (IDSImaging.Peak.Common.Types.MetadataKeys.Roi) is set such that the principal point of the calibration parameters lies outside the ROI, invalid data may appear at the image border. The image region is therefore restricted to points within the valid area.

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 metadata does not match the undistortion configuration.