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

Public Member Functions

None __init__ ()
 Initializes the AlignmentResult instance.
 
None __init__ (AlignmentResult res)
 Initializes a copy of the AlignmentResult instance res. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
AlignmentResult assign (AlignmentResult res)
 Replaces the current state of self with a copy of the state of the AlignmentResult instance res. More...
 
Math.Matrix4D getTransform ()
 
None setTransform (Math.Matrix4D xform)
 
float getScore ()
 
None setScore (float score)
 
int getReferenceShapeSetIndex ()
 
None setReferenceShapeSetIndex (int idx)
 
int getReferenceShapeIndex ()
 
None setReferenceShapeIndex (int idx)
 
int getAlignedShapeIndex ()
 
None setAlignedShapeIndex (int idx)
 
float getOverlap ()
 
None setOverlap (float overlap)
 
float getColorOverlap ()
 
None setColorOverlap (float overlap)
 
float getReferenceSelfOverlap ()
 
None setReferenceSelfOverlap (float overlap)
 
float getReferenceColorSelfOverlap ()
 
None setReferenceColorSelfOverlap (float overlap)
 
float getAlignedSelfOverlap ()
 
None setAlignedSelfOverlap (float overlap)
 
float getAlignedColorSelfOverlap ()
 
None setAlignedColorSelfOverlap (float overlap)
 

Properties

 objectID = property(getObjectID)
 
 transform = property(getTransform, setTransform)
 
 score = property(getScore, setScore)
 
 referenceShapeSetIndex = property(getReferenceShapeSetIndex, setReferenceShapeSetIndex)
 
 referenceShapeIndex = property(getReferenceShapeIndex, setReferenceShapeIndex)
 
 alignedShapeIndex = property(getAlignedShapeIndex, setAlignedShapeIndex)
 
 overlap = property(getOverlap, setOverlap)
 
 colorOverlap = property(getColorOverlap, setColorOverlap)
 
 referenceSelfOverlap = property(getReferenceSelfOverlap, setReferenceSelfOverlap)
 
 referenceColorSelfOverlap = property(getReferenceColorSelfOverlap, setReferenceColorSelfOverlap)
 
 alignedSelfOverlap = property(getAlignedSelfOverlap, setAlignedSelfOverlap)
 
 alignedColorSelfOverlap = property(getAlignedColorSelfOverlap, setAlignedColorSelfOverlap)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Shape.AlignmentResult.__init__ ( AlignmentResult  res)

Initializes a copy of the AlignmentResult instance res.

Parameters
resThe AlignmentResult instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Shape.AlignmentResult.getObjectID ( )

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

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

AlignmentResult CDPL.Shape.AlignmentResult.assign ( AlignmentResult  res)

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

Parameters
resThe AlignmentResult instance to copy.
Returns
self

◆ getTransform()

Math.Matrix4D CDPL.Shape.AlignmentResult.getTransform ( )
Returns

◆ setTransform()

None CDPL.Shape.AlignmentResult.setTransform ( Math.Matrix4D  xform)
Parameters
xform

◆ getScore()

float CDPL.Shape.AlignmentResult.getScore ( )
Returns

◆ setScore()

None CDPL.Shape.AlignmentResult.setScore ( float  score)
Parameters
score

◆ getReferenceShapeSetIndex()

int CDPL.Shape.AlignmentResult.getReferenceShapeSetIndex ( )
Returns

◆ setReferenceShapeSetIndex()

None CDPL.Shape.AlignmentResult.setReferenceShapeSetIndex ( int  idx)
Parameters
idx

◆ getReferenceShapeIndex()

int CDPL.Shape.AlignmentResult.getReferenceShapeIndex ( )
Returns

◆ setReferenceShapeIndex()

None CDPL.Shape.AlignmentResult.setReferenceShapeIndex ( int  idx)
Parameters
idx

◆ getAlignedShapeIndex()

int CDPL.Shape.AlignmentResult.getAlignedShapeIndex ( )
Returns

◆ setAlignedShapeIndex()

None CDPL.Shape.AlignmentResult.setAlignedShapeIndex ( int  idx)
Parameters
idx

◆ getOverlap()

float CDPL.Shape.AlignmentResult.getOverlap ( )
Returns

◆ setOverlap()

None CDPL.Shape.AlignmentResult.setOverlap ( float  overlap)
Parameters
overlap

◆ getColorOverlap()

float CDPL.Shape.AlignmentResult.getColorOverlap ( )
Returns

◆ setColorOverlap()

None CDPL.Shape.AlignmentResult.setColorOverlap ( float  overlap)
Parameters
overlap

◆ getReferenceSelfOverlap()

float CDPL.Shape.AlignmentResult.getReferenceSelfOverlap ( )
Returns

◆ setReferenceSelfOverlap()

None CDPL.Shape.AlignmentResult.setReferenceSelfOverlap ( float  overlap)
Parameters
overlap

◆ getReferenceColorSelfOverlap()

float CDPL.Shape.AlignmentResult.getReferenceColorSelfOverlap ( )
Returns

◆ setReferenceColorSelfOverlap()

None CDPL.Shape.AlignmentResult.setReferenceColorSelfOverlap ( float  overlap)
Parameters
overlap

◆ getAlignedSelfOverlap()

float CDPL.Shape.AlignmentResult.getAlignedSelfOverlap ( )
Returns

◆ setAlignedSelfOverlap()

None CDPL.Shape.AlignmentResult.setAlignedSelfOverlap ( float  overlap)
Parameters
overlap

◆ getAlignedColorSelfOverlap()

float CDPL.Shape.AlignmentResult.getAlignedColorSelfOverlap ( )
Returns

◆ setAlignedColorSelfOverlap()

None CDPL.Shape.AlignmentResult.setAlignedColorSelfOverlap ( float  overlap)
Parameters
overlap