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

Public Member Functions

None __init__ ()
 Initializes the FastGaussianShapeOverlapFunction instance.
 
None __init__ (GaussianShapeFunction ref_shape_func, GaussianShapeFunction ovl_shape_func)
 Initializes the FastGaussianShapeOverlapFunction instance. More...
 
None __init__ (FastGaussianShapeOverlapFunction func)
 Initializes a copy of the FastGaussianShapeOverlapFunction instance func. More...
 
FastGaussianShapeOverlapFunction assign (FastGaussianShapeOverlapFunction func)
 Replaces the current state of self with a copy of the state of the FastGaussianShapeOverlapFunction instance func. More...
 
None proximityOptimization (bool enable)
 
bool proximityOptimization ()
 
None setRadiusScalingFactor (float factor)
 
float getRadiusScalingFactor ()
 
None fastExpFunction (bool enable)
 
bool fastExpFunction ()
 
- Public Member Functions inherited from CDPL.Shape.GaussianShapeOverlapFunction
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None setShapeFunction (GaussianShapeFunction func, bool is_ref)
 
GaussianShapeFunction getShapeFunction (bool ref)
 
None setColorMatchFunction (Pharm.BoolSizeType2Functor func)
 
Pharm.BoolSizeType2Functor getColorMatchFunction ()
 
None setColorFilterFunction (BoolSizeTypeFunctor func)
 
BoolSizeTypeFunctor getColorFilterFunction ()
 
float calcSelfOverlap (bool ref)
 
float calcColorSelfOverlap (bool ref)
 
float calcOverlap ()
 
float calcOverlap (Math.Vector3DArray coords)
 
float calcColorOverlap ()
 
float calcColorOverlap (Math.Vector3DArray coords)
 
float calcOverlapGradient (Math.Vector3DArray coords, Math.Vector3DArray grad)
 

Static Public Attributes

float DEF_RADIUS_SCALING_FACTOR = 1.4
 

Properties

 proximityOpt = property(proximityOptimization, proximityOptimization)
 
 radiusScalingFactor = property(getRadiusScalingFactor, setRadiusScalingFactor)
 
 fastExpFunc = property(fastExpFunction, fastExpFunction)
 
- Properties inherited from CDPL.Shape.GaussianShapeOverlapFunction
 objectID = property(getObjectID)
 
 colorMatchFunction = property(getColorMatchFunction, setColorMatchFunction)
 
 colorFilterFunction = property(getColorFilterFunction, setColorFilterFunction)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Shape.FastGaussianShapeOverlapFunction.__init__ ( GaussianShapeFunction  ref_shape_func,
GaussianShapeFunction  ovl_shape_func 
)

Initializes the FastGaussianShapeOverlapFunction instance.

Parameters
ref_shape_func
ovl_shape_func

◆ __init__() [2/2]

None CDPL.Shape.FastGaussianShapeOverlapFunction.__init__ ( FastGaussianShapeOverlapFunction  func)

Initializes a copy of the FastGaussianShapeOverlapFunction instance func.

Parameters
funcThe FastGaussianShapeOverlapFunction instance to copy.

Member Function Documentation

◆ assign()

FastGaussianShapeOverlapFunction CDPL.Shape.FastGaussianShapeOverlapFunction.assign ( FastGaussianShapeOverlapFunction  func)

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

Parameters
funcThe FastGaussianShapeOverlapFunction instance to copy.
Returns
self

◆ proximityOptimization() [1/2]

None CDPL.Shape.FastGaussianShapeOverlapFunction.proximityOptimization ( bool  enable)
Parameters
enable

◆ proximityOptimization() [2/2]

bool CDPL.Shape.FastGaussianShapeOverlapFunction.proximityOptimization ( )
Returns

◆ setRadiusScalingFactor()

None CDPL.Shape.FastGaussianShapeOverlapFunction.setRadiusScalingFactor ( float  factor)
Parameters
factor

◆ getRadiusScalingFactor()

float CDPL.Shape.FastGaussianShapeOverlapFunction.getRadiusScalingFactor ( )
Returns

◆ fastExpFunction() [1/2]

None CDPL.Shape.FastGaussianShapeOverlapFunction.fastExpFunction ( bool  enable)
Parameters
enable

◆ fastExpFunction() [2/2]

bool CDPL.Shape.FastGaussianShapeOverlapFunction.fastExpFunction ( )
Returns