Undistortion Class Reference

#include <peak_icv/algorithms/transformations/peak_icv_undistortion.hpp>

Inheritance diagram for Undistortion:

Public Member Functions
	Undistortion (const IntrinsicParameters &intrinsicParameters)
	Constructs an undistortion using intrinsic parameters.
	Undistortion (const IntrinsicParameters &intrinsicParameters, const peak::common::Metadata &metadata)
	Constructs an undistortion using intrinsic parameters and metadata.
	Undistortion (const CalibrationParameters &calibrationParameters)
	Constructs an undistortion using calibration parameters.
	Undistortion (const CalibrationParameters &calibrationParameters, const peak::common::Metadata &metadata)
	Constructs an undistortion using calibration parameters and metadata.
	Undistortion (const CalibrationResult &calibrationResult)
	Constructs an undistortion using a calibration result.
	Undistortion (const CalibrationResult &calibrationResult, const peak::common::Metadata &metadata)
	Constructs an undistortion using a calibration result and metadata.
	Undistortion (const Undistortion &other)
	Undistortion (Undistortion &&other) noexcept
	~Undistortion () override
Undistortion &	operator= (const Undistortion &other)
Undistortion &	operator= (Undistortion &&other) noexcept
UndistortedImage	Process (const Image &image) const
	Applies undistortion to the specified image.
Interpolation	GetInterpolation () const
void	SetInterpolation (Interpolation interpolation)
	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

ids_peak_icv 1.1

Definition at line 57 of file peak_icv_undistortion.hpp.

Constructor & Destructor Documentation

Undistortion() [1/8]

Undistortion ( const IntrinsicParameters & intrinsicParameters )

inlineexplicit

Constructs an undistortion using intrinsic parameters.

Parameters

[in]

intrinsicParameters

Intrinsic calibration parameters.

Since

ids_peak_icv 1.1

Definition at line 201 of file peak_icv_undistortion.hpp.

Undistortion() [2/8]

Undistortion ( const IntrinsicParameters & intrinsicParameters, const peak::common::Metadata & metadata )

inline

Constructs an undistortion using intrinsic parameters and metadata.

Parameters

[in]	intrinsicParameters	Intrinsic calibration parameters.
[in]	metadata	Metadata describing capture characteristics.

Since

ids_peak_icv 1.1

Definition at line 210 of file peak_icv_undistortion.hpp.

Undistortion() [3/8]

Undistortion ( const CalibrationParameters & calibrationParameters )

inlineexplicit

Constructs an undistortion using calibration parameters.

Parameters

[in]

calibrationParameters

Calibration parameters.

Since

ids_peak_icv 1.1

Definition at line 221 of file peak_icv_undistortion.hpp.

Undistortion() [4/8]

Undistortion ( const CalibrationParameters & calibrationParameters, const peak::common::Metadata & metadata )

inline

Constructs an undistortion using calibration parameters and metadata.

Parameters

[in]	calibrationParameters	Calibration parameters.
[in]	metadata	Metadata describing capture characteristics.

Since

ids_peak_icv 1.1

Definition at line 230 of file peak_icv_undistortion.hpp.

Undistortion() [5/8]

Undistortion ( const CalibrationResult & calibrationResult )

inlineexplicit

Constructs an undistortion using a calibration result.

Parameters

[in]

calibrationResult

Calibration result.

Since

ids_peak_icv 1.1

Definition at line 241 of file peak_icv_undistortion.hpp.

Undistortion() [6/8]

Undistortion ( const CalibrationResult & calibrationResult, const peak::common::Metadata & metadata )

inline

Constructs an undistortion using a calibration result and metadata.

Parameters

[in]	calibrationResult	Calibration result.
[in]	metadata	Metadata describing capture characteristics.

Since

ids_peak_icv 1.1

Definition at line 251 of file peak_icv_undistortion.hpp.

Undistortion() [7/8]

Undistortion ( const Undistortion & other )

inline

Definition at line 263 of file peak_icv_undistortion.hpp.

Undistortion() [8/8]

Undistortion ( Undistortion && other )

inlinenoexcept

Definition at line 275 of file peak_icv_undistortion.hpp.

~Undistortion()

~Undistortion ( )

inlineoverride

Definition at line 286 of file peak_icv_undistortion.hpp.

Member Function Documentation

GetInterpolation()

Interpolation GetInterpolation ( ) const

inline

Returns

The current interpolation method used by the undistortion.

Since

ids_peak_icv 1.1

Definition at line 349 of file peak_icv_undistortion.hpp.

operator=() [1/2]

Undistortion & operator= ( const Undistortion & other )

inline

Definition at line 294 of file peak_icv_undistortion.hpp.

operator=() [2/2]

Undistortion & operator= ( Undistortion && other )

inlinenoexcept

Definition at line 315 of file peak_icv_undistortion.hpp.

Process()

UndistortedImage Process ( const Image & image ) const

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

[in]

image

The image to be undistorted.

Supported pixel formats

Mono8 Mono10 Mono12 Mono16 RGB8 RGBa8 BGR8 BGRa8 Coord3D_C32f Coord3D_ABC32f

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Returns

An undistorted image with updated intrinsic parameters.

Exceptions

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

Returns

The undistorted image.

Since

ids_peak_icv 1.1

Definition at line 335 of file peak_icv_undistortion.hpp.

SetInterpolation()

void SetInterpolation ( Interpolation interpolation )

inline

Sets the Interpolation method used for undistortion.

Parameters

[in]

interpolation

interpolation method to use.

Since

ids_peak_icv 1.1

Definition at line 360 of file peak_icv_undistortion.hpp.