Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Math.FKabschAlgorithm Class Reference
+ Inheritance diagram for CDPL.Math.FKabschAlgorithm:

Public Member Functions

None __init__ ()
 Initializes the FKabschAlgorithm instance.
 
None __init__ (FKabschAlgorithm algo)
 Initializes a copy of the FKabschAlgorithm instance algo. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
FKabschAlgorithm assign (FKabschAlgorithm algo)
 Replaces the current state of self with a copy of the state of the FKabschAlgorithm instance algo. More...
 
FMatrix getTransform ()
 
bool align (ConstFMatrixExpression points, ConstFMatrixExpression ref_points, bool do_center=True, int max_svd_iter=0)
 
bool align (ConstDMatrixExpression points, ConstDMatrixExpression ref_points, bool do_center=True, int max_svd_iter=0)
 
bool align (ConstFMatrixExpression points, ConstFMatrixExpression ref_points, ConstFVectorExpression weights, bool do_center=True, int max_svd_iter=0)
 
bool align (ConstDMatrixExpression points, ConstDMatrixExpression ref_points, ConstDVectorExpression weights, bool do_center=True, int max_svd_iter=0)
 

Properties

 objectID = property(getObjectID)
 
 transform = property(getTransform)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Math.FKabschAlgorithm.__init__ ( FKabschAlgorithm  algo)

Initializes a copy of the FKabschAlgorithm instance algo.

Parameters
algoThe FKabschAlgorithm instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.FKabschAlgorithm.getObjectID ( )

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

Different Python FKabschAlgorithm 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 FKabschAlgorithm 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()

FKabschAlgorithm CDPL.Math.FKabschAlgorithm.assign ( FKabschAlgorithm  algo)

Replaces the current state of self with a copy of the state of the FKabschAlgorithm instance algo.

Parameters
algoThe FKabschAlgorithm instance to copy.
Returns
self

◆ getTransform()

FMatrix CDPL.Math.FKabschAlgorithm.getTransform ( )
Returns

◆ align() [1/4]

bool CDPL.Math.FKabschAlgorithm.align ( ConstFMatrixExpression  points,
ConstFMatrixExpression  ref_points,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
do_center
max_svd_iter
Returns

◆ align() [2/4]

bool CDPL.Math.FKabschAlgorithm.align ( ConstDMatrixExpression  points,
ConstDMatrixExpression  ref_points,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
do_center
max_svd_iter
Returns

◆ align() [3/4]

bool CDPL.Math.FKabschAlgorithm.align ( ConstFMatrixExpression  points,
ConstFMatrixExpression  ref_points,
ConstFVectorExpression  weights,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
weights
do_center
max_svd_iter
Returns

◆ align() [4/4]

bool CDPL.Math.FKabschAlgorithm.align ( ConstDMatrixExpression  points,
ConstDMatrixExpression  ref_points,
ConstDVectorExpression  weights,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
weights
do_center
max_svd_iter
Returns