LineScanCalibrationConfiguration Class Reference

A set of parameters, which is used to configure linescan calibration calculated with function cvb.foundation.create_line_scan_calibration. More...

Public Member Functions
None	LineScanCalibrationConfiguration (self, int max_iterations=50, float poly_degree=3, float tolerance=1e-6, int scan_direction=cvb.ScanDirection.Y, int pre_defined_pixel_size_mode=cvb.PreDefinedPixelSizeMode.DoNotUse, float pixel_size=1)
	Default linescan calibration configuration.

Properties
	max_iterations = property
	int: The number of maximal iterations for all non linear solvers in the calibration algorithm.
	pixel_size = property
	float: The pixel size of transformed image.
	poly_degree = property
	int: A positive (or zero) integer value that defines the polynomial to be used.
	pre_defined_pixel_size_mode = property
	int: The decision if it uses predefined pixel size (see cvb.foundation.PreDefinedPixelSizeMode).
	scan_direction = property
	int: The scanning direction of camera (see cvb.foundation.ScanDirection).
	tolerance = property
	float: The value for early stopping criteria.

Detailed Description

A set of parameters, which is used to configure linescan calibration calculated with function cvb.foundation.create_line_scan_calibration.

Constructor & Destructor Documentation

LineScanCalibrationConfiguration()

None LineScanCalibrationConfiguration	(		self,
		int	max_iterations = 50,
		float	poly_degree = 3,
		float	tolerance = 1e-6,
		int	scan_direction = cvb.ScanDirection.Y,
		int	pre_defined_pixel_size_mode = cvb.PreDefinedPixelSizeMode.DoNotUse,
		float	pixel_size = 1 )

Default linescan calibration configuration.

Parameters

max_iterations : int Number of maximal iterations for all nonlinear solvers in the calibration algorithm.

poly_degree : float A positive (or zero) integer value that defines the polynomial to be used. Note, that currently only a polynomial of degree 3 is supported.

tolerance : float Value for early stopping criteria.

scan_direction : int Scanning direction of camera (see cvb.foundation.ScanDirection).

pre_defined_pixel_size_mode : int Decision if predefined pixel size needs to be used (see cvb.foundation.PreDefinedPixelSizeMode).

pixel_size : float Pixel size of transformed image.

Property Documentation

pixel_size

pixel_size = property

static

float: The pixel size of transformed image.

This value will only be considered, if LineScanCalibrationConfiguration.pre_defined_pixel_size_mode is set to cvb.foundation.PreDefinedPixelSizeMode.Use. The pixel size of the transformed image will be equal to this value. The pixel_size must have the same units as reference_distance_calibration_points and reference_width_stripes specified in cvb.foundation.create_line_scan_calibration.

poly_degree

poly_degree = property

static

int: A positive (or zero) integer value that defines the polynomial to be used.

Note, that currently only a polynomial of degree 3 is supported.

pre_defined_pixel_size_mode

pre_defined_pixel_size_mode = property

static

int: The decision if it uses predefined pixel size (see cvb.foundation.PreDefinedPixelSizeMode).

If this value is set to cvb.foundation.PreDefinedPixelSizeMode.Use, the transformed image will have a fixed pixel size. The desired pixel size has to be set via LineScanCalibrationConfiguration.pixel_size.