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

Public Member Functions

None __init__ ()
 Initializes the PrincipalAxesAlignmentStartGenerator instance.
 
None __init__ (PrincipalAxesAlignmentStartGenerator gen)
 Initializes a copy of the PrincipalAxesAlignmentStartGenerator instance gen. More...
 
None setSymmetryThreshold (float thresh)
 
float getSymmetryThreshold ()
 
None genShapeCenterStarts (bool generate)
 
bool genShapeCenterStarts ()
 
None genColorCenterStarts (bool generate)
 
bool genColorCenterStarts ()
 
None genNonColorCenterStarts (bool generate)
 
bool genNonColorCenterStarts ()
 
None genRandomStarts (bool generate)
 
bool genRandomStarts ()
 
None genForAlignedShapeCenters (bool generate)
 
bool genForAlignedShapeCenters ()
 
None genForReferenceShapeCenters (bool generate)
 
bool genForReferenceShapeCenters ()
 
None genForLargerShapeCenters (bool generate)
 
bool genForLargerShapeCenters ()
 
None setMaxRandomTranslation (float max_trans)
 
float getMaxRandomTranslation ()
 
None setNumRandomStarts (int num_starts)
 
int getNumRandomStarts ()
 
None setRandomSeed (int seed)
 
PrincipalAxesAlignmentStartGenerator assign (PrincipalAxesAlignmentStartGenerator gen)
 Replaces the current state of self with a copy of the state of the PrincipalAxesAlignmentStartGenerator instance gen. More...
 
- Public Member Functions inherited from CDPL.Shape.GaussianShapeAlignmentStartGenerator
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int setupReference (GaussianShapeFunction func, Math.Matrix4D xform)
 
int setupAligned (GaussianShapeFunction func, Math.Matrix4D xform)
 
None setReference (GaussianShapeFunction func, int sym_class)
 
bool generate (GaussianShapeFunction func, int sym_class)
 
int getNumStartTransforms ()
 
int getNumStartSubTransforms ()
 
Math.Vector7D getStartTransform (int idx)
 
int __len__ ()
 
Math.Vector7D __getitem__ (int idx)
 

Static Public Attributes

float DEF_SYMMETRY_THRESHOLD = 0.15
 
int DEF_NUM_RANDOM_STARTS = 4
 
float DEF_MAX_RANDOM_TRANSLATION = 2.0
 

Properties

 symmetryThreshold = property(getSymmetryThreshold, setSymmetryThreshold)
 
 maxRandomTranslation = property(getMaxRandomTranslation, setMaxRandomTranslation)
 
 numRandomStarts = property(getNumRandomStarts, setNumRandomStarts)
 
 shapeCenterStarts = property(genShapeCenterStarts, genShapeCenterStarts)
 
 colorCenterStarts = property(genColorCenterStarts, genColorCenterStarts)
 
 nonColorCenterStarts = property(genNonColorCenterStarts, genNonColorCenterStarts)
 
 randomStarts = property(getNumRandomStarts, setNumRandomStarts)
 
 genForAlignedShapeCtrs = property(genForAlignedShapeCenters, genForAlignedShapeCenters)
 
 genForReferenceShapeCrs = property(genForReferenceShapeCenters, genForReferenceShapeCenters)
 
 genForLargerShapeCtrs = property(genForLargerShapeCenters, genForLargerShapeCenters)
 
- Properties inherited from CDPL.Shape.GaussianShapeAlignmentStartGenerator
 objectID = property(getObjectID)
 
 numStartSubTransforms = property(getNumStartSubTransforms)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.__init__ ( PrincipalAxesAlignmentStartGenerator  gen)

Initializes a copy of the PrincipalAxesAlignmentStartGenerator instance gen.

Parameters
genThe PrincipalAxesAlignmentStartGenerator instance to copy.

Member Function Documentation

◆ setSymmetryThreshold()

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.setSymmetryThreshold ( float  thresh)
Parameters
thresh

◆ getSymmetryThreshold()

float CDPL.Shape.PrincipalAxesAlignmentStartGenerator.getSymmetryThreshold ( )
Returns

◆ genShapeCenterStarts() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genShapeCenterStarts ( bool  generate)
Parameters
generate

◆ genShapeCenterStarts() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genShapeCenterStarts ( )
Returns

◆ genColorCenterStarts() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genColorCenterStarts ( bool  generate)
Parameters
generate

◆ genColorCenterStarts() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genColorCenterStarts ( )
Returns

◆ genNonColorCenterStarts() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genNonColorCenterStarts ( bool  generate)
Parameters
generate

◆ genNonColorCenterStarts() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genNonColorCenterStarts ( )
Returns

◆ genRandomStarts() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genRandomStarts ( bool  generate)
Parameters
generate

◆ genRandomStarts() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genRandomStarts ( )
Returns

◆ genForAlignedShapeCenters() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForAlignedShapeCenters ( bool  generate)
Parameters
generate

◆ genForAlignedShapeCenters() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForAlignedShapeCenters ( )
Returns

◆ genForReferenceShapeCenters() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForReferenceShapeCenters ( bool  generate)
Parameters
generate

◆ genForReferenceShapeCenters() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForReferenceShapeCenters ( )
Returns

◆ genForLargerShapeCenters() [1/2]

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForLargerShapeCenters ( bool  generate)
Parameters
generate

◆ genForLargerShapeCenters() [2/2]

bool CDPL.Shape.PrincipalAxesAlignmentStartGenerator.genForLargerShapeCenters ( )
Returns

◆ setMaxRandomTranslation()

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.setMaxRandomTranslation ( float  max_trans)
Parameters
max_trans

◆ getMaxRandomTranslation()

float CDPL.Shape.PrincipalAxesAlignmentStartGenerator.getMaxRandomTranslation ( )
Returns

◆ setNumRandomStarts()

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.setNumRandomStarts ( int  num_starts)
Parameters
num_starts

◆ getNumRandomStarts()

int CDPL.Shape.PrincipalAxesAlignmentStartGenerator.getNumRandomStarts ( )
Returns

◆ setRandomSeed()

None CDPL.Shape.PrincipalAxesAlignmentStartGenerator.setRandomSeed ( int  seed)
Parameters
seed

◆ assign()

PrincipalAxesAlignmentStartGenerator CDPL.Shape.PrincipalAxesAlignmentStartGenerator.assign ( PrincipalAxesAlignmentStartGenerator  gen)

Replaces the current state of self with a copy of the state of the PrincipalAxesAlignmentStartGenerator instance gen.

Parameters
genThe PrincipalAxesAlignmentStartGenerator instance to copy.
Returns
self
Generated by doxygen 1.9.1