|  |  | 
src.structures.Residue
Amino
ALA
ARG
ASN
ASP
CYS
GLN
GLU
GLY
HIS
ILE
LEU
LYS
MET
PHE
PRO
SER
THR
TRP
TYR
VAL
LIG
WAT
 
 
| class ALA(Amino)
 |  |  | Alanine class 
 This class gives data about the Alanine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:ALAAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class ARG(Amino)
 |  |  | Arginine class 
 This class gives data about the Arginine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:ARGAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class ASN(Amino)
 |  |  | Asparagine class 
 This class gives data about the Asparagine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:ASNAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class ASP(Amino)
 |  |  | Aspartic Acid class 
 This class gives data about the Aspartic Acid object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:ASPAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Set the name to use for the forcefield based on the currentstate.
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class Amino(src.structures.Residue)
 |  |  | Amino class 
 This class provides standard features of the amino acids listed
 below
 
 Parameters
 atoms:  A list of Atom objects to be stored in this class
 (list)
 ref:    The reference object for the amino acid.  Used to
 convert from the alternate naming scheme to the
 main naming scheme.
 
 |  |  | Methods defined here: 
 __init__(self, atoms, ref)
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class CYS(Amino)
 |  |  | Cysteine class 
 This class gives data about the Cysteine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:CYSAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Set the state of the CYS object.  If SS-bonded, use CYX.  Ifnegatively charged, use CYM.  If HG is not present, use CYX.
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class GLN(Amino)
 |  |  | Glutamine class 
 This class gives data about the Glutamine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:GLNAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class GLU(Amino)
 |  |  | Glutamic Acid class 
 This class gives data about the Glutamic Acid object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:GLUAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Set the name to use for the forcefield based on the currentstate.
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class GLY(Amino)
 |  |  | Glycine class 
 This class gives data about the Glycine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:GLYAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class HIS(Amino)
 |  |  | Histidine class 
 This class gives data about the Histidine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:HISAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Histidines are a special case due to the presence ofseveral different forms.  This function sets all non-
 positive incarnations of HIS to neutral HIS by
 checking to see if optimization removed hacceptor or
 hdonor flags.  Otherwise HID is used as the default.
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class ILE(Amino)
 |  |  | Isoleucine class 
 This class gives data about the Isoleucine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:ILEAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class LEU(Amino)
 |  |  | Leucine class 
 This class gives data about the Leucine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:LEUAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class LIG(src.structures.Residue)
 |  |  | Generic ligand class 
 This class gives data about the generic ligand object, and inherits
 off the base residue class.
 
 |  |  | Methods defined here: 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 createAtom(self, atomname, newcoords)Create a water atom.  Note the HETATM field.
 Parameters
 atomname: The name of the atom (string)
 newcoords:  The new coordinates of the atom (list)
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class LYS(Amino)
 |  |  | Lysine class 
 This class gives data about the Lysine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:LYSAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Determine if this is LYN or not
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class MET(Amino)
 |  |  | Methionine class 
 This class gives data about the Methionine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:METAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class PHE(Amino)
 |  |  | Phenylalanine class 
 This class gives data about the Phenylalanine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:PHEAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class PRO(Amino)
 |  |  | Proline class 
 This class gives data about the Proline object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:PROAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class SER(Amino)
 |  |  | Serine class 
 This class gives data about the Serine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:SERAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class THR(Amino)
 |  |  | Threonine class 
 This class gives data about the Threonine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:THRAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class TRP(Amino)
 |  |  | Tryptophan class 
 This class gives data about the Tryptophan object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:TRPAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class TYR(Amino)
 |  |  | Tyrosine class 
 This class gives data about the Tyrosine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:TYRAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 setState(self)See if the TYR is negative or not
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class VAL(Amino)
 |  |  | Valine class 
 This class gives data about the Valine object, and inherits
 off the base residue class.
 
 |  |  | Method resolution order:VALAminosrc.structures.Residue
 Methods defined here:
 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 Methods inherited from Amino:
 
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 addDihedralAngle(self, value)Add the value to the list of chiangles
 Parameters
 value: The value to be added (float)
 createAtom(self, atomname, newcoords)Create an atom.  Override the generic residue's version ofcreateAtom().
 
 Parameters
 atomname:  The name of the atom (string)
 newcoords: The coordinates of the atom (list).
 setState(self)Set the name to use for the forcefield based on the currentstate.  Uses N* and C* for termini.
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  
 
| class WAT(src.structures.Residue)
 |  |  | Water class 
 This class gives data about the Water object, and inherits
 off the base residue class.
 
 |  |  | Methods defined here: 
 __init__(self, atoms, ref)Initialize the class
 Parameters
 atoms:      A list of Atom objects to be stored in this class
 (list)
 addAtom(self, atom)Override the existing addAtom - include the link to thereference object
 createAtom(self, atomname, newcoords)Create a water atom.  Note the HETATM field.
 Parameters
 atomname: The name of the atom (string)
 newcoords:  The new coordinates of the atom (list)
 Methods inherited from src.structures.Residue:
 
 __str__(self)Basic string representation for debugging
 addMissing(self, value)Add the value to the list of missing atoms
 Parameters
 value: The name of the missing atom (string)
 get(self, name)Get a member of the Residue class
 Parameters
 name:          The name of the member (string)
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chainID:       The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 missing:     List of missing atoms of the residue
 Returns
 item:          The value of the member
 getAtom(self, name)Retrieve an atom from the mapping
 Parameters
 resname: The name of the residue to retrieve (string)
 getAtoms(self)
 getCharge(self)Get the total charge of the residue.  In order to get ridof floating point rounding error, do the string
 transformation.
 
 Returns:
 charge: The charge of the residue (float)
 hasAtom(self, name)
 numAtoms(self)Get the number of atoms for the residue
 Returns
 count:  Number of atoms in the residue (int)
 removeAtom(self, atomname)Remove an atom from the residue object.
 Parameters
 atomname: The name of the atom to be removed (string)
 renameAtom(self, oldname, newname)Rename an atom to a new name
 Parameters
 oldname: The old atom name (string)
 newname: The new atom name (string)
 renameResidue(self, name)Rename a given residue
 Parameters
 name:       The new name of the residue
 reorder(self)Reorder the atoms to start with N, CA, C, O if they exist
 rotateTetrahedral(self, atom1, atom2, angle)Rotate about the atom1-atom2 bond by a given angleAll atoms connected to atom2 will rotate.
 
 Parameters:
 atom1:  The first atom of the bond to rotate about (atom)
 atom2:  The second atom of the bond to rotate about (atom)
 angle:  The number of degrees to rotate (float)
 set(self, name, value)Set a member of the Residue class to a specific value 
 Parameters
 name:          The name of the object to set (string)
 value:         The object to append
 Possible Values
 atoms:         The atoms in the residue
 name:          The name of the residue
 chain:         The chainID associated with the residue
 resSeq:        The sequence number of the residue
 icode:         The iCode of the residue
 SSbonded:      1 if the residue has a SS bond, 0 otherwise
 SSbondpartner: The residue of the bond partner
 type:          The type associated with this residue
 isNterm:       # of hydrogens if the residue is the N-Terminus, 0 otherwise
 isCterm:       1 if the residue is the C-Terminus, 0 otherwise
 isDirty:       1 if the residue is not missing atoms,
 0 otherwise
 Notes
 resSeq points to the residue.setResSeq function
 Returns
 item:          The value of the member
 setChainID(self, value)Set the chainID field to a certain value
 setDonorsAndAcceptors(self)Set the donors and acceptors within the residue
 setResSeq(self, value)Set the atom field resSeq to a certain value andchange the residue's information.  The icode field is no longer
 useful.
 
 Parameters
 value:  The new value of resSeq (int)
 |  |