eVision.Easy3D.EObjectBasedCalibrationGenerator Class Reference

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

Inheritance diagram for eVision.Easy3D.EObjectBasedCalibrationGenerator:

Collaboration diagram for eVision.Easy3D.EObjectBasedCalibrationGenerator:

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

Properties
	CalibrationObjectScaleX = property(_CalibrationObjectScaleX__getter, None)
	Returns the X axis scale of the calibration object.
	CalibrationObjectSizeA = property(_CalibrationObjectSizeA__getter, None)
	Returns the 'A' size of the calibration object.
	CalibrationObjectScaleY = property(_CalibrationObjectScaleY__getter, None)
	Returns the Y axis scale of the calibration object.
	CalibrationObjectSizeB = property(_CalibrationObjectSizeB__getter, None)
	Returns the 'B' size of the calibration object.
	CalibrationObjectScaleZ = property(_CalibrationObjectScaleZ__getter, None)
	Returns the Z axis scale of the calibration object.
	CalibrationObjectSizeC = property(_CalibrationObjectSizeC__getter, None)
	Returns the 'C' size of the calibration object.
	PrecisionVsSpeedTradeOff = property(_PrecisionVsSpeedTradeOff__getter, _PrecisionVsSpeedTradeOff__setter)
	Sets/Gets the trade-off between precision and speed for the calibration.
	AlongPositiveZAxis = property(_AlongPositiveZAxis__getter, _AlongPositiveZAxis__setter)
	Sets/Gets whether the calibration object is along the positive z-axis.
	NumCalibrationPasses = property(_NumCalibrationPasses__getter, _NumCalibrationPasses__setter)
	Sets/Gets the number of calibration passes.
	RangeX = property(_RangeX__getter, _RangeX__setter)
	Sets/Gets the 'X' axis range for the calibration object detection in the eVision.Easy3D.EDepthMap.
	RangeY = property(_RangeY__getter, _RangeY__setter)
	Sets/Gets the 'Y' axis range for the calibration object detection in the depth map.
	RangeZ = property(_RangeZ__getter, _RangeZ__setter)
	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.

Remarks:

License(s): Easy3DLaserLine

Constructor & Destructor Documentation

__init__() [1/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.__init__

(

self

)

Creates a eVision.Easy3D.EObjectBasedCalibrationGenerator.

__init__() [2/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.__init__	(		self,
		eVision.Easy3D.EObjectBasedCalibrationGenerator	other )

Creates a eVision.Easy3D.EObjectBasedCalibrationGenerator.

Parameters

other

The other eVision.Easy3D.EObjectBasedCalibrationGenerator.

Member Function Documentation

Compute() [1/3]

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

Computes an eVision.Easy3D.EObjectBasedCalibrationModel from the eVision.Easy3D.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	(		self,
		eVision.Easy3D.EDepthMap32f	dm )

Computes an eVision.Easy3D.EObjectBasedCalibrationModel from the eVision.Easy3D.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	(		self,
		eVision.Easy3D.EDepthMap8	dm )

Computes an eVision.Easy3D.EObjectBasedCalibrationModel from the eVision.Easy3D.EDepthMap of the calibration object.

Parameters

dm	The input depth map of the calibration object.

GetCalibrationObjectType()

eVision.Easy3D.EObjectBasedCalibrationType eVision.Easy3D.EObjectBasedCalibrationGenerator.GetCalibrationObjectType

(

self

)

Gets the eVision.Easy3D.EObjectBasedCalibrationType used for the computation of the eVision.Easy3D.EObjectBasedCalibrationModel.

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

Load() [1/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.Load	(		self,
		eVision.ESerializer | None	serializer )

Loads the parameters used by the object based calibration generator.

Parameters

serializer

The serializer.

Load() [2/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.Load	(		self,
		str	path )

Loads the parameters used by the object based calibration generator.

Parameters

path	The file path.

Save() [1/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.Save	(		self,
		eVision.ESerializer | None	serializer )

Saves the parameters used by the object based calibration generator.

Parameters

serializer

The eVision.ESerializer object that is written to.

Save() [2/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.Save	(		self,
		str	path )

Saves the parameters used by the object based calibration generator.

Parameters

path	The file path.

SetCalibrationObjectScale() [1/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectScale	(		self,
		float	scale )

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

Refer to the user guide for the eVision.Easy3D.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 eVision.Easy3D.EDepthMap to eVision.Easy3D.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 eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectType.

Deprecated

Use eVision.Easy3D.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.

Parameters

scale

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

SetCalibrationObjectScale() [2/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectScale	(		self,
		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 eVision.Easy3D.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 eVision.Easy3D.EDepthMap to eVision.Easy3D.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 eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectType.

Deprecated

Use eVision.Easy3D.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.

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.

SetCalibrationObjectType() [1/2]

None eVision.Easy3D.EObjectBasedCalibrationGenerator.SetCalibrationObjectType	(		self,
		eVision.Easy3D.EObjectBasedCalibrationType	type )

Sets the eVision.Easy3D.EObjectBasedCalibrationType used for the computation of the eVision.Easy3D.EObjectBasedCalibrationModel.

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

Remarks:

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

Parameters

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

SetCalibrationObjectType() [2/2]

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

Sets the eVision.Easy3D.EObjectBasedCalibrationType used for the computation of the eVision.Easy3D.EObjectBasedCalibrationModel.

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

Remarks:

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

Parameters

type	Sets the type of object calibration to detect in the eVision.Easy3D.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).

Property Documentation

AlongPositiveZAxis

eVision.Easy3D.EObjectBasedCalibrationGenerator.AlongPositiveZAxis = property(_AlongPositiveZAxis__getter, _AlongPositiveZAxis__setter)

static

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

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleX = property(_CalibrationObjectScaleX__getter, None)

static

Returns the X axis scale of the calibration object.

Deprecated

Use eVision.Easy3D.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

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleY = property(_CalibrationObjectScaleY__getter, None)

static

Returns the Y axis scale of the calibration object.

Deprecated

Use eVision.Easy3D.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

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectScaleZ = property(_CalibrationObjectScaleZ__getter, None)

static

Returns the Z axis scale of the calibration object.

Deprecated

Use eVision.Easy3D.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

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeA = property(_CalibrationObjectSizeA__getter, None)

static

Returns the 'A' size of the calibration object.

CalibrationObjectSizeB

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeB = property(_CalibrationObjectSizeB__getter, None)

static

Returns the 'B' size of the calibration object.

CalibrationObjectSizeC

eVision.Easy3D.EObjectBasedCalibrationGenerator.CalibrationObjectSizeC = property(_CalibrationObjectSizeC__getter, None)

static

Returns the 'C' size of the calibration object.

NumCalibrationPasses

eVision.Easy3D.EObjectBasedCalibrationGenerator.NumCalibrationPasses = property(_NumCalibrationPasses__getter, _NumCalibrationPasses__setter)

static

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.EObjectBasedCalibrationGenerator.PrecisionVsSpeedTradeOff = property(_PrecisionVsSpeedTradeOff__getter, _PrecisionVsSpeedTradeOff__setter)

static

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

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

RangeX

eVision.Easy3D.EObjectBasedCalibrationGenerator.RangeX = property(_RangeX__getter, _RangeX__setter)

static

Sets/Gets the 'X' axis range for the calibration object detection in the eVision.Easy3D.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.Easy3D.EObjectBasedCalibrationGenerator.RangeY = property(_RangeY__getter, _RangeY__setter)

static

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.Easy3D.EObjectBasedCalibrationGenerator.RangeZ = property(_RangeZ__getter, _RangeZ__setter)

static

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.