Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | Properties | List of all members
CDPL.ForceField.MMFF94TorsionInteractionParameterizer Class Reference

Detects and parameterizes the MMFF94 torsion interactions of a molecular graph. More...

+ Inheritance diagram for CDPL.ForceField.MMFF94TorsionInteractionParameterizer:

Public Member Functions

None __init__ ()
 Constructs an MMFF94TorsionInteractionParameterizer instance using the default MMFF94 parameter tables.
 
None __init__ (MMFF94TorsionInteractionParameterizer parameterizer)
 Initializes a copy of the MMFF94TorsionInteractionParameterizer instance parameterizer. More...
 
None __init__ (Chem.MolecularGraph molgraph, MMFF94TorsionInteractionList ia_list, bool strict)
 Constructs the parameterizer and processes the molecular graph molgraph. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None setFilterFunction (InteractionFilterFunction4 func)
 Sets the filter function used to skip atom quadruplets during parameterization. More...
 
None setAtomTypeFunction (MMFF94NumericAtomTypeFunction func)
 Sets the function used to look up the MMFF94 numeric atom type of an atom. More...
 
None setBondTypeIndexFunction (MMFF94BondTypeIndexFunction func)
 Sets the function used to look up the MMFF94 bond type index of a bond. More...
 
None setAromaticRingSetFunction (MMFF94RingSetFunction func)
 Sets the function used to obtain the set of MMFF94 aromatic rings of the input molecular graph. More...
 
None setTorsionParameterTable (MMFF94TorsionParameterTable table)
 Sets the primary table providing torsion type-specific \( V_1/V_2/V_3 \) parameters. More...
 
None setAtomTypePropertyTable (MMFF94AtomTypePropertyTable table)
 Sets the table providing MMFF94 numeric atom type property data (used by the empirical fallback). More...
 
None setParameterAtomTypeMap (MMFF94PrimaryToParameterAtomTypeMap map)
 Sets the map used to translate primary atom types into their corresponding parameter atom types. More...
 
MMFF94TorsionInteractionParameterizer assign (MMFF94TorsionInteractionParameterizer parameterizer)
 Replaces the current state of self with a copy of the state of the MMFF94TorsionInteractionParameterizer instance parameterizer. More...
 
None parameterize (Chem.MolecularGraph molgraph, MMFF94TorsionInteractionList ia_list, bool strict)
 Perceives the MMFF94 torsion interactions for molgraph and outputs the corresponding parameter data into ia_list. More...
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

Detects and parameterizes the MMFF94 torsion interactions of a molecular graph.

For every non-filtered atom quadruplet (i-j-k-l) consisting of a central bond j-k and one neighbor each on j and k the parameterizer looks up the matching MMFF94 torsion type-specific parameters \( V_1, V_2, V_3 \) from the supplied parameter table, falling back to the primary-to-parameter atom type map for atoms with no exact parameter entry, and emits an MMFF94TorsionInteraction instance.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.__init__ ( MMFF94TorsionInteractionParameterizer  parameterizer)

Initializes a copy of the MMFF94TorsionInteractionParameterizer instance parameterizer.

Parameters
parameterizerThe MMFF94TorsionInteractionParameterizer instance to copy.

◆ __init__() [2/2]

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.__init__ ( Chem.MolecularGraph  molgraph,
MMFF94TorsionInteractionList  ia_list,
bool  strict 
)

Constructs the parameterizer and processes the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to parameterize the torsion interactions.
ia_listOutput list receiving the generated MMFF94TorsionInteraction instances.
strictIf True, missing/ambiguous parameters cause a parameterization failure. Otherwise, in case of parameterization problems, suitable fallback parameters will be used.

Member Function Documentation

◆ getObjectID()

int CDPL.ForceField.MMFF94TorsionInteractionParameterizer.getObjectID ( )

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

Different Python MMFF94TorsionInteractionParameterizer 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 MMFF94TorsionInteractionParameterizer 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.

◆ setFilterFunction()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setFilterFunction ( InteractionFilterFunction4  func)

Sets the filter function used to skip atom quadruplets during parameterization.

Parameters
funcThe new four-atom filter function (when it returns False, the quadruplet is skipped).

◆ setAtomTypeFunction()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setAtomTypeFunction ( MMFF94NumericAtomTypeFunction  func)

Sets the function used to look up the MMFF94 numeric atom type of an atom.

Parameters
funcThe new numeric atom type lookup function.

◆ setBondTypeIndexFunction()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setBondTypeIndexFunction ( MMFF94BondTypeIndexFunction  func)

Sets the function used to look up the MMFF94 bond type index of a bond.

Parameters
funcThe new bond type index lookup function.

◆ setAromaticRingSetFunction()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setAromaticRingSetFunction ( MMFF94RingSetFunction  func)

Sets the function used to obtain the set of MMFF94 aromatic rings of the input molecular graph.

Parameters
funcThe new aromatic ring set retrievaly function.

◆ setTorsionParameterTable()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setTorsionParameterTable ( MMFF94TorsionParameterTable  table)

Sets the primary table providing torsion type-specific \( V_1/V_2/V_3 \) parameters.

Parameters
tableThe new torsion parameter table.

◆ setAtomTypePropertyTable()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setAtomTypePropertyTable ( MMFF94AtomTypePropertyTable  table)

Sets the table providing MMFF94 numeric atom type property data (used by the empirical fallback).

Parameters
tableThe new atom type property table.

◆ setParameterAtomTypeMap()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.setParameterAtomTypeMap ( MMFF94PrimaryToParameterAtomTypeMap  map)

Sets the map used to translate primary atom types into their corresponding parameter atom types.

Parameters
mapThe new primary-to-parameter atom type map.

◆ assign()

MMFF94TorsionInteractionParameterizer CDPL.ForceField.MMFF94TorsionInteractionParameterizer.assign ( MMFF94TorsionInteractionParameterizer  parameterizer)

Replaces the current state of self with a copy of the state of the MMFF94TorsionInteractionParameterizer instance parameterizer.

Parameters
parameterizerThe MMFF94TorsionInteractionParameterizer instance to copy.
Returns
self

◆ parameterize()

None CDPL.ForceField.MMFF94TorsionInteractionParameterizer.parameterize ( Chem.MolecularGraph  molgraph,
MMFF94TorsionInteractionList  ia_list,
bool  strict 
)

Perceives the MMFF94 torsion interactions for molgraph and outputs the corresponding parameter data into ia_list.

Parameters
molgraphThe molecular graph for which to parameterize the torsion interactions.
ia_listOutput list receiving the generated MMFF94TorsionInteraction instances.
strictIf True, missing/ambiguous parameters cause a parameterization failure. Otherwise, in case of parameterization problems, suitable fallback parameters will be used.