CDPL.Shape.GaussianShapeFunctionAlignment.Result Class Reference

A single alignment result: rigid-body transformation plus shape and color overlap values. More...

Inheritance diagram for CDPL.Shape.GaussianShapeFunctionAlignment.Result:

Public Member Functions
None	__init__ (Math.Matrix4D transform, float overlap, float col_overlap)
	Initializes the Result instance. More...
None	__init__ (Result res)
	Initializes a copy of the Result instance res. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
Result	assign (Result res)
	Replaces the current state of self with a copy of the state of the Result instance res. More...
Math.Matrix4D	getTransform ()
	Returns the rigid-body transformation that maps the aligned shape onto the reference shape. More...
float	getOverlap ()
	Returns the shape overlap value of the alignment. More...
float	getColorOverlap ()
	Returns the color overlap value of the alignment. More...

Properties
	objectID = property(getObjectID)
	transform = property(getTransform)
	overlap = property(getOverlap)
	colorOverlap = property(getColorOverlap)

Detailed Description

A single alignment result: rigid-body transformation plus shape and color overlap values.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Shape.GaussianShapeFunctionAlignment.Result.__init__	(	Math.Matrix4D	transform,
		float	overlap,
		float	col_overlap
	)

Initializes the Result instance.

Parameters

transform
overlap
col_overlap

__init__() [2/2]

None CDPL.Shape.GaussianShapeFunctionAlignment.Result.__init__

(

Result

res

)

Initializes a copy of the Result instance res.

Parameters

res	The Result instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Shape.GaussianShapeFunctionAlignment.Result.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python Result instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two Result instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign()

Result CDPL.Shape.GaussianShapeFunctionAlignment.Result.assign

(

Result

res

)

Replaces the current state of self with a copy of the state of the Result instance res.

Parameters

res	The Result instance to copy.

Returns

self

getTransform()

Math.Matrix4D CDPL.Shape.GaussianShapeFunctionAlignment.Result.getTransform

(

)

Returns the rigid-body transformation that maps the aligned shape onto the reference shape.

Returns

A reference to the rigid-body transformation matrix.

getOverlap()

float CDPL.Shape.GaussianShapeFunctionAlignment.Result.getOverlap

(

)

Returns the shape overlap value of the alignment.

Returns

The shape overlap value.

getColorOverlap()

float CDPL.Shape.GaussianShapeFunctionAlignment.Result.getColorOverlap

(

)

Returns the color overlap value of the alignment.

Returns

The color overlap value.