Package schrodinger :: Package application :: Package matsci :: Module amorphous :: Class TorsionAngler
[hide private]
[frames] | no frames]

Class TorsionAngler

object --+
         |
        TorsionAngler

Class to handle cycling a structure though a series of torsion values

Instance Methods [hide private]
 
__init__(self, options, minimum_steps=5, max_stepsize=15.0)
Create a TorsionAngler object
 
setData(self, struct, torsion_atoms)
Set the structure to operate on and the 4 atoms involved in the torsion
float
getTorsionValueInRange(self)
Get a value for the torsion that falls within the specified range.
schrodinger.structure.Structure
rotomers(self)
A generator for structures that step the torsion through the desired values.
 
incrementTorsionValue(self)
Sets the torsion property to the next value to try for a dihedral as we rotate it through its allowed range.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, options, minimum_steps=5, max_stepsize=15.0)
(Constructor)

 

Create a TorsionAngler object

Parameters:
  • options (argparse.Namespace) - Object with dihedral_min and dihedral_max properties that describe the minimum and maximum allowed dihedral angles
  • minimum_steps - The minimum steps to take. The actual number of steps may be larger if the allowed range of torsions is greather than max_stepsize*minimum_steps.
  • max_stepsize (float) - The largest number of degrees to move the torsion per step.
  • minimium_steps (int)
Overrides: object.__init__

setData(self, struct, torsion_atoms)

 

Set the structure to operate on and the 4 atoms involved in the torsion

Parameters:
  • struct (schrodinger.structure.Structure) - The struct containing the torsion to rotate
  • torsion_atoms (list) - A four int list, each int is the atom index of an atom in the torsion, in the order A-B-C-D, where B-C is the bond that rotates when the torsion changes.

getTorsionValueInRange(self)

 

Get a value for the torsion that falls within the specified range. The user may have supplied 150-210, but the measured value might be -170 instead of 190. Convert the measured value to fall within the range.

Returns: float
The torsion value converted to fall within the range specified for the min/max of the torsion values.

rotomers(self)

 

A generator for structures that step the torsion through the desired values.

Returns: schrodinger.structure.Structure
Each yield gives the structure with the specified torsion marched through the specified values.