Represents an object-based 3D calibration generator. More...

Inheritance diagram for eVision.Easy3D.EObjectBasedCalibrationGenerator:

[legend]

Collaboration diagram for eVision.Easy3D.EObjectBasedCalibrationGenerator:

[legend]

Public Member Functions
	EObjectBasedCalibrationGenerator ()
	Creates a EObjectBasedCalibrationGenerator.
	EObjectBasedCalibrationGenerator (eVision.Easy3D.EObjectBasedCalibrationGenerator other)
	Creates a EObjectBasedCalibrationGenerator.
void	SetCalibrationObjectType (eVision.Easy3D.EObjectBasedCalibrationType type)
	Sets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.
void	SetCalibrationObjectType (eVision.Easy3D.EObjectBasedCalibrationType type, float sizeA, float sizeB, float sizeC)
	Sets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.
eVision.Easy3D.EObjectBasedCalibrationType	GetCalibrationObjectType ()
	Gets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.
void	SetCalibrationObjectScale (float scale)
	Sets the scale of your target calibration model compared to a reference model.
void	SetCalibrationObjectScale (float scaleX, float scaleY, float scaleZ)
	Sets the scale of your target calibration model compared to a reference model.
eVision.Easy3D.EObjectBasedCalibrationModel	Compute (eVision.Easy3D.EDepthMap8 dm)
	Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.
eVision.Easy3D.EObjectBasedCalibrationModel	Compute (eVision.Easy3D.EDepthMap16 dm)
	Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.
eVision.Easy3D.EObjectBasedCalibrationModel	Compute (eVision.Easy3D.EDepthMap32f dm)
	Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.
void	Save (string path)
	Saves the parameters used by the object based calibration generator.
void	Save (eVision.ESerializer serializer)
	Saves the parameters used by the object based calibration generator.
void	Load (string path)
	Loads the parameters used by the object based calibration generator.
void	Load (eVision.ESerializer serializer)
	Loads the parameters used by the object based calibration generator.

Properties
float	CalibrationObjectScaleX `[get]`
	Returns the X axis scale of the calibration object.
float	CalibrationObjectSizeA `[get]`
	Returns the 'A' size of the calibration object.
float	CalibrationObjectScaleY `[get]`
	Returns the Y axis scale of the calibration object.
float	CalibrationObjectSizeB `[get]`
	Returns the 'B' size of the calibration object.
float	CalibrationObjectScaleZ `[get]`
	Returns the Z axis scale of the calibration object.
float	CalibrationObjectSizeC `[get]`
	Returns the 'C' size of the calibration object.
eVision.Easy3D.EObjectBasedCalibrationPrecisionVsSpeedTradeOff	PrecisionVsSpeedTradeOff `[get, set]`
	Sets/Gets the trade-off between precision and speed for the calibration.
bool	AlongPositiveZAxis `[get, set]`
	Sets/Gets whether the calibration object is along the positive z-axis.
int	NumCalibrationPasses `[get, set]`
	Sets/Gets the number of calibration passes.
eVision.EIntegerRange	RangeX `[get, set]`
	Sets/Gets the 'X' axis range for the calibration object detection in the EDepthMap.
eVision.EIntegerRange	RangeY `[get, set]`
	Sets/Gets the 'Y' axis range for the calibration object detection in the depth map.
eVision.EFloatRange	RangeZ `[get, set]`
	Sets/Gets the 'Z' axis range for the calibration object detection in the depth map.

Detailed Description

Represents an object-based 3D calibration generator.

The class performs the computation of a calibration model based on the scan of the reference object.

License(s): Easy3DLaserLine

Constructor & Destructor Documentation

◆ EObjectBasedCalibrationGenerator() [1/2]

eVision.Easy3D.EObjectBasedCalibrationGenerator.EObjectBasedCalibrationGenerator ( )

Creates a EObjectBasedCalibrationGenerator.

◆ EObjectBasedCalibrationGenerator() [2/2]

eVision.Easy3D.EObjectBasedCalibrationGenerator.EObjectBasedCalibrationGenerator ( eVision.Easy3D.EObjectBasedCalibrationGenerator other )

Creates a EObjectBasedCalibrationGenerator.

Parameters

other The other EObjectBasedCalibrationGenerator.

Member Function Documentation

◆ Compute() [1/3]

eVision.Easy3D.EObjectBasedCalibrationModel eVision.Easy3D.EObjectBasedCalibrationGenerator.Compute ( eVision.Easy3D.EDepthMap16 dm )

Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.

Parameters

dm	The input depth map of the calibration object.

◆ Compute() [2/3]

eVision.Easy3D.EObjectBasedCalibrationModel eVision.Easy3D.EObjectBasedCalibrationGenerator.Compute ( eVision.Easy3D.EDepthMap32f dm )

Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.

Parameters

dm	The input depth map of the calibration object.

◆ Compute() [3/3]

eVision.Easy3D.EObjectBasedCalibrationModel eVision.Easy3D.EObjectBasedCalibrationGenerator.Compute ( eVision.Easy3D.EDepthMap8 dm )

Computes an EObjectBasedCalibrationModel from the EDepthMap of the calibration object.

Parameters

dm	The input depth map of the calibration object.

◆ GetCalibrationObjectType()

eVision.Easy3D.EObjectBasedCalibrationType eVision.Easy3D.EObjectBasedCalibrationGenerator.GetCalibrationObjectType ( )

Gets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.

The type of the object used for the calibration is E3DObjectBasedCalibrationType_NotDefined by default.

◆ Load() [1/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.Load ( eVision.ESerializer serializer )

Loads the parameters used by the object based calibration generator.

Parameters

serializer The serializer.

◆ Load() [2/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.Load ( string path )

Loads the parameters used by the object based calibration generator.

Parameters

path	The file path.

◆ Save() [1/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.Save ( eVision.ESerializer serializer )

Saves the parameters used by the object based calibration generator.

Parameters

serializer The ESerializer object that is written to.

◆ Save() [2/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.Save ( string path )

Saves the parameters used by the object based calibration generator.

Parameters

path	The file path.

◆ SetCalibrationObjectScale() [1/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectScale ( float scale )

Sets the scale of your target calibration model compared to a reference model.

Refer to the user guide for the EObjectBasedCalibrationModel reference design. Use that value to set the unit of the calibrated positions in the point cloud. The scale will affect the world coordinates after conversion of the EDepthMap to EPointCloud. For example, if "1 reference unit" is equal to "10 millimeters", set "10" as scale value. Then applying the calibration will produce results in millimeters. Changing these values affect the calibration object sizes defined by EObjectBasedCalibrationGenerator.SetCalibrationObjectType.

Parameters

scale Sets the same scale on axis X, Y and Z relative to the calibration object reference size.

Deprecated

Use EObjectBasedCalibrationGenerator.SetCalibrationObjectType instead. Note that the scale and size arguments aren't the same thing.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ SetCalibrationObjectScale() [2/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectScale	(	float	scaleX,
		float	scaleY,
		float	scaleZ )

Sets the scale of your target calibration model compared to a reference model.

Refer to the user guide for the EObjectBasedCalibrationModel reference design. Use that value to set the unit of the calibrated positions in the point cloud. The scale will affect the world coordinates after conversion of the EDepthMap to EPointCloud. For example, if "1 reference unit" is equal to "10 millimeters", set "10" as scale value. Then applying the calibration will produce results in millimeters. Changing these values affect the calibration object sizes defined by EObjectBasedCalibrationGenerator.SetCalibrationObjectType.

Parameters

scaleX	Sets the scale on X axis relative to the calibration object reference size.
scaleY	Sets the scale on Y axis relative to the calibration object reference size.
scaleZ	Sets the scale on Z axis relative to the calibration object reference size.

Deprecated

Use EObjectBasedCalibrationGenerator.SetCalibrationObjectType instead. Note that the scale and size arguments aren't the same thing.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ SetCalibrationObjectType() [1/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectType ( eVision.Easy3D.EObjectBasedCalibrationType type )

Sets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.

The type of the object used for the calibration is E3DObjectBasedCalibrationType_NotDefined by default.

Parameters

type	Sets the type of object calibration to detect in the EDepthMap.

'sizeA', 'sizeB', and 'sizeC' values are in metric unit. The resulting point cloud positions after applying the calibration will follow the same metric unit. Refer to the eVision user guide, Easy3D calibration section, for the definition of 'A', 'B' and 'C' dimensions.

◆ SetCalibrationObjectType() [2/2]

void eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectType	(	eVision.Easy3D.EObjectBasedCalibrationType	type,
		float	sizeA,
		float	sizeB,
		float	sizeC )

Sets the EObjectBasedCalibrationType used for the computation of the EObjectBasedCalibrationModel.

The type of the object used for the calibration is E3DObjectBasedCalibrationType_NotDefined by default.

Parameters

type	Sets the type of object calibration to detect in the EDepthMap.
sizeA	Sets the size 'A' of object calibration (1 by default).
sizeB	Sets the size 'B' of object calibration (1 by default).
sizeC	Sets the size 'C' of object calibration (1 by default).

'sizeA', 'sizeB', and 'sizeC' values are in metric unit. The resulting point cloud positions after applying the calibration will follow the same metric unit. Refer to the eVision user guide, Easy3D calibration section, for the definition of 'A', 'B' and 'C' dimensions.

Property Documentation

◆ AlongPositiveZAxis

bool eVision.Easy3D.EObjectBasedCalibrationGenerator.AlongPositiveZAxis

getset

Sets/Gets whether the calibration object is along the positive z-axis.

If True, the top of the calibration object in the depthmap is expected to have a higher z value than the bottom.
If False, the top of the calibration object in the depthmap is expected to have a lower z value than the bottom.

True by default.

◆ CalibrationObjectScaleX

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleX

get

Returns the X axis scale of the calibration object.

Deprecated

Use EObjectBasedCalibrationGenerator.CalibrationObjectSizeA instead. Note that scale and size aren't the same thing.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ CalibrationObjectScaleY

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleY

get

Returns the Y axis scale of the calibration object.

Deprecated

Use EObjectBasedCalibrationGenerator.CalibrationObjectSizeB instead. Note that scale and size aren't the same thing.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ CalibrationObjectScaleZ

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleZ

get

Returns the Z axis scale of the calibration object.

Deprecated

Use EObjectBasedCalibrationGenerator.CalibrationObjectSizeC instead. Note that scale and size aren't the same thing.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ CalibrationObjectSizeA

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeA

get

Returns the 'A' size of the calibration object.

◆ CalibrationObjectSizeB

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeB

get

Returns the 'B' size of the calibration object.

◆ CalibrationObjectSizeC

float eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeC

get

Returns the 'C' size of the calibration object.

◆ NumCalibrationPasses

int eVision.Easy3D.EObjectBasedCalibrationGenerator.NumCalibrationPasses

getset

Sets/Gets the number of calibration passes.

Each passes will refine the calibration model but the computation will be longer. The number of passes is 1 by default.

◆ PrecisionVsSpeedTradeOff

eVision.Easy3D.EObjectBasedCalibrationPrecisionVsSpeedTradeOff eVision.Easy3D.EObjectBasedCalibrationGenerator.PrecisionVsSpeedTradeOff

getset

Sets/Gets the trade-off between precision and speed for the calibration.

The Precision vs speed trade-off mode from EObjectBasedCalibrationPrecisionVsSpeedTradeOff is EObjectBasedCalibrationPrecisionVsSpeedTradeOff_Balanced by default.

◆ RangeX

eVision.EIntegerRange eVision.Easy3D.EObjectBasedCalibrationGenerator.RangeX

getset

Sets/Gets the 'X' axis range for the calibration object detection in the EDepthMap.

If max value is smaller than min value, then max will not be used, we use depth map width - 1 instead. If min value is smaller than 0, then min will not be used, we use 0 instead.

◆ RangeY

eVision.EIntegerRange eVision.Easy3D.EObjectBasedCalibrationGenerator.RangeY

getset

Sets/Gets the 'Y' axis range for the calibration object detection in the depth map.

If max value is smaller than min value, then max will not be used, we use depth map height - 1 instead. If min value is smaller than 0, then min will not be used, we use 0 instead.

◆ RangeZ

eVision.EFloatRange eVision.Easy3D.EObjectBasedCalibrationGenerator.RangeZ

getset

Sets/Gets the 'Z' axis range for the calibration object detection in the depth map.

if max value is smaller than min value, then max will not be used, we use the maximum float value instead. if min value is smaller than 0, then min will not be used, we use 0 instead.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EObjectBasedCalibrationGenerator() [1/2]

◆ EObjectBasedCalibrationGenerator() [2/2]

Member Function Documentation

◆ Compute() [1/3]

◆ Compute() [2/3]

◆ Compute() [3/3]

◆ GetCalibrationObjectType()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetCalibrationObjectScale() [1/2]

◆ SetCalibrationObjectScale() [2/2]

◆ SetCalibrationObjectType() [1/2]

◆ SetCalibrationObjectType() [2/2]

Property Documentation

◆ AlongPositiveZAxis

◆ CalibrationObjectScaleX

◆ CalibrationObjectScaleY

◆ CalibrationObjectScaleZ

◆ CalibrationObjectSizeA

◆ CalibrationObjectSizeB

◆ CalibrationObjectSizeC

◆ NumCalibrationPasses

◆ PrecisionVsSpeedTradeOff

◆ RangeX

◆ RangeY

◆ RangeZ