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

Public Member Functions

None __init__ ()
 Initializes the Vector2DArrayAlignmentCalculator instance.
 
None __init__ (Vector2DArrayAlignmentCalculator algo)
 Initializes a copy of the Vector2DArrayAlignmentCalculator instance algo. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Vector2DArrayAlignmentCalculator assign (Vector2DArrayAlignmentCalculator algo)
 Replaces the current state of self with a copy of the state of the Vector2DArrayAlignmentCalculator instance algo. More...
 
DMatrix getTransform ()
 
bool calculate (Vector2DArray points, Vector2DArray ref_points, bool do_center=True, int max_svd_iter=0)
 
bool calculate (Vector2DArray points, Vector2DArray ref_points, ConstFVectorExpression weights, bool do_center=True, int max_svd_iter=0)
 
bool calculate (Vector2DArray points, Vector2DArray 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.Vector2DArrayAlignmentCalculator.__init__ ( Vector2DArrayAlignmentCalculator  algo)

Initializes a copy of the Vector2DArrayAlignmentCalculator instance algo.

Parameters
algoThe Vector2DArrayAlignmentCalculator instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.Vector2DArrayAlignmentCalculator.getObjectID ( )

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

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

Vector2DArrayAlignmentCalculator CDPL.Math.Vector2DArrayAlignmentCalculator.assign ( Vector2DArrayAlignmentCalculator  algo)

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

Parameters
algoThe Vector2DArrayAlignmentCalculator instance to copy.
Returns
self

◆ getTransform()

DMatrix CDPL.Math.Vector2DArrayAlignmentCalculator.getTransform ( )
Returns

◆ calculate() [1/3]

bool CDPL.Math.Vector2DArrayAlignmentCalculator.calculate ( Vector2DArray  points,
Vector2DArray  ref_points,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
do_center
max_svd_iter
Returns

◆ calculate() [2/3]

bool CDPL.Math.Vector2DArrayAlignmentCalculator.calculate ( Vector2DArray  points,
Vector2DArray  ref_points,
ConstFVectorExpression  weights,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
weights
do_center
max_svd_iter
Returns

◆ calculate() [3/3]

bool CDPL.Math.Vector2DArrayAlignmentCalculator.calculate ( Vector2DArray  points,
Vector2DArray  ref_points,
ConstDVectorExpression  weights,
bool   do_center = True,
int   max_svd_iter = 0 
)
Parameters
points
ref_points
weights
do_center
max_svd_iter
Returns