Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator Class Reference

FeatureAutoCorrelation3DVectorCalculator. More...

+ Inheritance diagram for CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator:

Public Member Functions

None __init__ ()
 Constructs the FeatureAutoCorrelation3DVectorCalculator instance.
 
None __init__ (FeatureAutoCorrelation3DVectorCalculator calc)
 Initializes a copy of the FeatureAutoCorrelation3DVectorCalculator instance calc. More...
 
None __init__ (Pharm.FeatureContainer cntnr, Math.DVector vec)
 Initializes the FeatureAutoCorrelation3DVectorCalculator instance. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
FeatureAutoCorrelation3DVectorCalculator assign (FeatureAutoCorrelation3DVectorCalculator calc)
 Replaces the current state of self with a copy of the state of the FeatureAutoCorrelation3DVectorCalculator instance calc. More...
 
None setEntityPairWeightFunction (Pharm.DoubleFeature2Functor func)
 
None setEntity3DCoordinatesFunction (Pharm.Feature3DCoordinatesFunction func)
 
None setNumSteps (int num_steps)
 
int getNumSteps ()
 
None setRadiusIncrement (float radius_inc)
 
float getRadiusIncrement ()
 
None setStartRadius (float start_radius)
 
float getStartRadius ()
 
None calculate (Pharm.FeatureContainer cntnr, Math.DVector vec)
 

Properties

 objectID = property(getObjectID)
 
 startRadius = property(getStartRadius, setStartRadius)
 
 radiusIncrement = property(getRadiusIncrement, setRadiusIncrement)
 
 numSteps = property(getNumSteps, setNumSteps)
 

Detailed Description

FeatureAutoCorrelation3DVectorCalculator.

See also
[CITB, HBMD]

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.__init__ ( FeatureAutoCorrelation3DVectorCalculator  calc)

Initializes a copy of the FeatureAutoCorrelation3DVectorCalculator instance calc.

Parameters
calcThe FeatureAutoCorrelation3DVectorCalculator instance to copy.

◆ __init__() [2/2]

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.__init__ ( Pharm.FeatureContainer  cntnr,
Math.DVector  vec 
)

Initializes the FeatureAutoCorrelation3DVectorCalculator instance.

Parameters
cntnr
vec

Member Function Documentation

◆ getObjectID()

int CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.getObjectID ( )

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

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

FeatureAutoCorrelation3DVectorCalculator CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.assign ( FeatureAutoCorrelation3DVectorCalculator  calc)

Replaces the current state of self with a copy of the state of the FeatureAutoCorrelation3DVectorCalculator instance calc.

Parameters
calcThe FeatureAutoCorrelation3DVectorCalculator instance to copy.
Returns
self

◆ setEntityPairWeightFunction()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.setEntityPairWeightFunction ( Pharm.DoubleFeature2Functor  func)
Parameters
func

◆ setEntity3DCoordinatesFunction()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.setEntity3DCoordinatesFunction ( Pharm.Feature3DCoordinatesFunction  func)
Parameters
func

◆ setNumSteps()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.setNumSteps ( int  num_steps)
Parameters
num_steps

◆ getNumSteps()

int CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.getNumSteps ( )
Returns

◆ setRadiusIncrement()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.setRadiusIncrement ( float  radius_inc)
Parameters
radius_inc

◆ getRadiusIncrement()

float CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.getRadiusIncrement ( )
Returns

◆ setStartRadius()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.setStartRadius ( float  start_radius)
Parameters
start_radius

◆ getStartRadius()

float CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.getStartRadius ( )
Returns

◆ calculate()

None CDPL.Descr.FeatureAutoCorrelation3DVectorCalculator.calculate ( Pharm.FeatureContainer  cntnr,
Math.DVector  vec 
)
Parameters
cntnr
vec