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

Public Member Functions

None __init__ ()
 Initializes the SpatialAtomAlignment instance.
 
None __init__ (SpatialAtomAlignment alignment)
 Initializes a copy of the SpatialAtomAlignment instance alignment. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None setEntityMatchFunction (ForceField.InteractionFilterFunction2 func)
 
ForceField.InteractionFilterFunction2 getEntityMatchFunction ()
 
None setEntityPairMatchFunction (ForceField.InteractionFilterFunction4 func)
 
ForceField.InteractionFilterFunction4 getEntityPairMatchFunction ()
 
None setTopAlignmentConstraintFunction (BoolSTPairArrayFunctor func)
 
BoolSTPairArrayFunctor getTopAlignmentConstraintFunction ()
 
None setEntity3DCoordinatesFunction (Atom3DCoordinatesFunction func)
 
Atom3DCoordinatesFunction getEntity3DCoordinatesFunction ()
 
None setEntityWeightFunction (ForceField.MMFF94AtomChargeFunction func)
 
ForceField.MMFF94AtomChargeFunction getEntityWeightFunction ()
 
None performExhaustiveSearch (bool exhaustive)
 
bool exhaustiveSearchPerformed ()
 
None addEntity (Atom entity, bool first_set)
 
None clearEntities (bool first_set)
 
int getNumEntities (bool first_set)
 
object getEntities (bool first_set)
 
Atom getEntity (int idx, bool first_set)
 
None setMinTopologicalMappingSize (int min_size)
 
int getMinTopologicalMappingSize ()
 
None reset ()
 
bool nextAlignment ()
 
Math.Matrix4D getTransform ()
 
SpatialAtomAlignment assign (SpatialAtomAlignment alignment)
 Replaces the current state of self with a copy of the state of the SpatialAtomAlignment instance alignment. More...
 
Util.STPairArray getTopologicalMapping ()
 

Properties

 objectID = property(getObjectID)
 
 topMapping = property(getTopologicalMapping)
 
 minTopologicalMappingSize = property(getMinTopologicalMappingSize, setMinTopologicalMappingSize)
 
 exhaustiveSearch = property(exhaustiveSearchPerformed, performExhaustiveSearch)
 
 transform = property(getTransform)
 
 entityMatchFunction = property(getEntityMatchFunction, setEntityMatchFunction)
 
 entityPairMatchFunction = property(getEntityPairMatchFunction, setEntityPairMatchFunction)
 
 topAlignmentConstraintFunction = property(getTopAlignmentConstraintFunction, setTopAlignmentConstraintFunction)
 
 entityCoordsFunction = property(getEntity3DCoordinatesFunction, setEntity3DCoordinatesFunction)
 
 entityWeightFunction = property(getEntityWeightFunction, setEntityWeightFunction)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Chem.SpatialAtomAlignment.__init__ ( SpatialAtomAlignment  alignment)

Initializes a copy of the SpatialAtomAlignment instance alignment.

Parameters
alignmentThe SpatialAtomAlignment instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Chem.SpatialAtomAlignment.getObjectID ( )

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

Different Python SpatialAtomAlignment 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 SpatialAtomAlignment 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.

◆ setEntityMatchFunction()

None CDPL.Chem.SpatialAtomAlignment.setEntityMatchFunction ( ForceField.InteractionFilterFunction2  func)
Parameters
func

◆ getEntityMatchFunction()

ForceField.InteractionFilterFunction2 CDPL.Chem.SpatialAtomAlignment.getEntityMatchFunction ( )
Returns

◆ setEntityPairMatchFunction()

None CDPL.Chem.SpatialAtomAlignment.setEntityPairMatchFunction ( ForceField.InteractionFilterFunction4  func)
Parameters
func

◆ getEntityPairMatchFunction()

ForceField.InteractionFilterFunction4 CDPL.Chem.SpatialAtomAlignment.getEntityPairMatchFunction ( )
Returns

◆ setTopAlignmentConstraintFunction()

None CDPL.Chem.SpatialAtomAlignment.setTopAlignmentConstraintFunction ( BoolSTPairArrayFunctor  func)
Parameters
func

◆ getTopAlignmentConstraintFunction()

BoolSTPairArrayFunctor CDPL.Chem.SpatialAtomAlignment.getTopAlignmentConstraintFunction ( )
Returns

◆ setEntity3DCoordinatesFunction()

None CDPL.Chem.SpatialAtomAlignment.setEntity3DCoordinatesFunction ( Atom3DCoordinatesFunction  func)
Parameters
func

◆ getEntity3DCoordinatesFunction()

Atom3DCoordinatesFunction CDPL.Chem.SpatialAtomAlignment.getEntity3DCoordinatesFunction ( )
Returns

◆ setEntityWeightFunction()

None CDPL.Chem.SpatialAtomAlignment.setEntityWeightFunction ( ForceField.MMFF94AtomChargeFunction  func)
Parameters
func

◆ getEntityWeightFunction()

ForceField.MMFF94AtomChargeFunction CDPL.Chem.SpatialAtomAlignment.getEntityWeightFunction ( )
Returns

◆ performExhaustiveSearch()

None CDPL.Chem.SpatialAtomAlignment.performExhaustiveSearch ( bool  exhaustive)
Parameters
exhaustive

◆ exhaustiveSearchPerformed()

bool CDPL.Chem.SpatialAtomAlignment.exhaustiveSearchPerformed ( )
Returns

◆ addEntity()

None CDPL.Chem.SpatialAtomAlignment.addEntity ( Atom  entity,
bool  first_set 
)
Parameters
entity
first_set

◆ clearEntities()

None CDPL.Chem.SpatialAtomAlignment.clearEntities ( bool  first_set)
Parameters
first_set

◆ getNumEntities()

int CDPL.Chem.SpatialAtomAlignment.getNumEntities ( bool  first_set)
Parameters
first_set
Returns

◆ getEntities()

object CDPL.Chem.SpatialAtomAlignment.getEntities ( bool  first_set)
Parameters
first_set
Returns

◆ getEntity()

Atom CDPL.Chem.SpatialAtomAlignment.getEntity ( int  idx,
bool  first_set 
)
Parameters
idx
first_set
Returns

◆ setMinTopologicalMappingSize()

None CDPL.Chem.SpatialAtomAlignment.setMinTopologicalMappingSize ( int  min_size)
Parameters
min_size

◆ getMinTopologicalMappingSize()

int CDPL.Chem.SpatialAtomAlignment.getMinTopologicalMappingSize ( )
Returns

◆ reset()

None CDPL.Chem.SpatialAtomAlignment.reset ( )
Parameters
reset

◆ nextAlignment()

bool CDPL.Chem.SpatialAtomAlignment.nextAlignment ( )
Returns

◆ getTransform()

Math.Matrix4D CDPL.Chem.SpatialAtomAlignment.getTransform ( )
Returns

◆ assign()

SpatialAtomAlignment CDPL.Chem.SpatialAtomAlignment.assign ( SpatialAtomAlignment  alignment)

Replaces the current state of self with a copy of the state of the SpatialAtomAlignment instance alignment.

Parameters
alignmentThe SpatialAtomAlignment instance to copy.
Returns
self

◆ getTopologicalMapping()

Util.STPairArray CDPL.Chem.SpatialAtomAlignment.getTopologicalMapping ( )
Returns