Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Static Public Attributes | Properties | List of all members
CDPL.Pharm.FeatureGeometryMatchFunctor Class Reference

FeatureGeometryMatchFunctor. More...

+ Inheritance diagram for CDPL.Pharm.FeatureGeometryMatchFunctor:

Public Member Functions

None __init__ (FeatureGeometryMatchFunctor func)
 Initializes a copy of the FeatureGeometryMatchFunctor instance func. More...
 
None __init__ (float max_hba_int_dir_angle=85.0, float max_hba_orient_dev=45.0, float max_hbd_int_dir_dev=45.0, float max_xba_int_dir_dev=45.0, float max_xbd_int_dir_dev=45.0, float max_ar_orient_dev=45.0)
 Initializes the FeatureGeometryMatchFunctor instance. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
FeatureGeometryMatchFunctor assign (FeatureGeometryMatchFunctor func)
 Replaces the current state of self with a copy of the state of the FeatureGeometryMatchFunctor instance func. More...
 
float getMaxHBAInteractionDirAngle ()
 
None setMaxHBAInteractionDirAngle (float angle)
 
float getMaxHBAOrientationDeviation ()
 
None setMaxHBAOrientationDeviation (float angle)
 
float getMaxHBDInteractionDirDeviation ()
 
None setMaxHBDInteractionDirDeviation (float angle)
 
float getMaxXBAInteractionDirDeviation ()
 
None setMaxXBAInteractionDirDeviation (float angle)
 
float getMaxXBDInteractionDirDeviation ()
 
None setMaxXBDInteractionDirDeviation (float angle)
 
float getMaxAROrientationDeviation ()
 
None setMaxAROrientationDeviation (float angle)
 
bool __call__ (Feature ftr1, Feature ftr2)
 Calculates a score reflecting the goodness of the spatial feature orientation match. More...
 
bool __call__ (Feature ftr1, Feature ftr2, Math.Matrix4D xform)
 Calculates a score reflecting the goodness of the spatial feature orientation match. More...
 

Static Public Attributes

float DEF_MAX_HBA_INTERACTION_DIR_ANGLE = 85.0
 
float DEF_MAX_HBA_ORIENTATION_DEVIATION = 45.0
 
float DEF_MAX_HBD_INTERACTION_DIR_DEVIATION = 45.0
 
float DEF_MAX_XBA_INTERACTION_DIR_DEVIATION = 45.0
 
float DEF_MAX_XBD_INTERACTION_DIR_DEVIATION = 45.0
 
float DEF_MAX_AR_ORIENTATION_DEVIATION = 45.0
 

Properties

 objectID = property(getObjectID)
 
 maxHBAInteractionDirAngle = property(getMaxHBAInteractionDirAngle, setMaxHBAInteractionDirAngle)
 
 maxHBAOrientationDeviation = property(getMaxHBAOrientationDeviation, setMaxHBAOrientationDeviation)
 
 maxHBDInteractionDirDeviation = property(getMaxHBDInteractionDirDeviation, setMaxHBDInteractionDirDeviation)
 
 maxXBDInteractionDirDeviation = property(getMaxXBDInteractionDirDeviation, setMaxXBDInteractionDirDeviation)
 
 maxXBAInteractionDirDeviation = property(getMaxXBAInteractionDirDeviation, setMaxXBAInteractionDirDeviation)
 
 maxAROrientationDeviation = property(getMaxAROrientationDeviation, setMaxAROrientationDeviation)
 

Detailed Description

FeatureGeometryMatchFunctor.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Pharm.FeatureGeometryMatchFunctor.__init__ ( FeatureGeometryMatchFunctor  func)

Initializes a copy of the FeatureGeometryMatchFunctor instance func.

Parameters
funcThe FeatureGeometryMatchFunctor instance to copy.

◆ __init__() [2/2]

None CDPL.Pharm.FeatureGeometryMatchFunctor.__init__ ( float   max_hba_int_dir_angle = 85.0,
float   max_hba_orient_dev = 45.0,
float   max_hbd_int_dir_dev = 45.0,
float   max_xba_int_dir_dev = 45.0,
float   max_xbd_int_dir_dev = 45.0,
float   max_ar_orient_dev = 45.0 
)

Initializes the FeatureGeometryMatchFunctor instance.

Parameters
max_hba_int_dir_angle
max_hba_orient_dev
max_hbd_int_dir_dev
max_xba_int_dir_dev
max_xbd_int_dir_dev
max_ar_orient_dev

Member Function Documentation

◆ getObjectID()

int CDPL.Pharm.FeatureGeometryMatchFunctor.getObjectID ( )

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

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

FeatureGeometryMatchFunctor CDPL.Pharm.FeatureGeometryMatchFunctor.assign ( FeatureGeometryMatchFunctor  func)

Replaces the current state of self with a copy of the state of the FeatureGeometryMatchFunctor instance func.

Parameters
funcThe FeatureGeometryMatchFunctor instance to copy.
Returns
self

◆ getMaxHBAInteractionDirAngle()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxHBAInteractionDirAngle ( )
Returns

◆ setMaxHBAInteractionDirAngle()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxHBAInteractionDirAngle ( float  angle)
Parameters
angle

◆ getMaxHBAOrientationDeviation()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxHBAOrientationDeviation ( )
Returns

◆ setMaxHBAOrientationDeviation()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxHBAOrientationDeviation ( float  angle)
Parameters
angle

◆ getMaxHBDInteractionDirDeviation()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxHBDInteractionDirDeviation ( )
Returns

◆ setMaxHBDInteractionDirDeviation()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxHBDInteractionDirDeviation ( float  angle)
Parameters
angle

◆ getMaxXBAInteractionDirDeviation()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxXBAInteractionDirDeviation ( )
Returns

◆ setMaxXBAInteractionDirDeviation()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxXBAInteractionDirDeviation ( float  angle)
Parameters
angle

◆ getMaxXBDInteractionDirDeviation()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxXBDInteractionDirDeviation ( )
Returns

◆ setMaxXBDInteractionDirDeviation()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxXBDInteractionDirDeviation ( float  angle)
Parameters
angle

◆ getMaxAROrientationDeviation()

float CDPL.Pharm.FeatureGeometryMatchFunctor.getMaxAROrientationDeviation ( )
Returns

◆ setMaxAROrientationDeviation()

None CDPL.Pharm.FeatureGeometryMatchFunctor.setMaxAROrientationDeviation ( float  angle)
Parameters
angle

◆ __call__() [1/2]

bool CDPL.Pharm.FeatureGeometryMatchFunctor.__call__ ( Feature  ftr1,
Feature  ftr2 
)

Calculates a score reflecting the goodness of the spatial feature orientation match.

Parameters
ftr1The first feature.
ftr2The second feature.
Returns
A score from 0 (=spatial deviation outside the allowed range) and 1 (optimum match) describing the goodness of the spatial orientation match of the two features.

◆ __call__() [2/2]

bool CDPL.Pharm.FeatureGeometryMatchFunctor.__call__ ( Feature  ftr1,
Feature  ftr2,
Math.Matrix4D  xform 
)

Calculates a score reflecting the goodness of the spatial feature orientation match.

Parameters
ftr1The first feature.
ftr2The second feature.
xformThe transformation to apply to the spatial orientation of the second feature.
Returns
A score from 0 (=spatial deviation outside the allowed range) and 1 (optimum match) describing the goodness of the spatial orientation match of the two features.