tagTool
index
/home/schwitrs/xplor/python/tagTool.py


 
Class to aid in attaching tag residues.
 
To add a new tag:
 
import tagTool
tagTool.tagDB['resname'] = tagTool.TagDBInfo('resname',...)

 
Classes
       
builtins.object
TagDBInfo
TagInfo
TagTool

 
class TagDBInfo(builtins.object)
    TagDBInfo(tagName, attachAtoms, topology=None, parameters=None, coords=None, coordsFilename=None, paraAtomname=None, rigidRegions=None)
 

 
  Methods defined here:
__init__(self, tagName, attachAtoms, topology=None, parameters=None, coords=None, coordsFilename=None, paraAtomname=None, rigidRegions=None)
where: 
    tagName      -  residueName of the tag
    attachAtoms  -  name of 3 atoms used to attach tag to biomolecule-
                   order is significant
    topology     -  filename of topoogy file
    parameters   -  filename of parameters file
    coords       -  after initialization, contains a dictionary 
                   containing entries of
                       (segid,resid) -> "PDB ATOM RECORD"
    coordFilename - filename of PDB containing tag coordinates with
                   optional rotamer weights.
    paraAtomname  - name of paramagnetic atom in tag.
    rigidRegions  - sequence of strings containing names of atoms to
                   grouped in rigid bodies.

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)

 
class TagInfo(TagDBInfo)
    TagInfo(dbInfo, tool)
 

 
 
Method resolution order:
TagInfo
TagDBInfo
builtins.object

Methods defined here:
__init__(self, dbInfo, tool)
where: 
    tagName      -  residueName of the tag
    attachAtoms  -  name of 3 atoms used to attach tag to biomolecule-
                   order is significant
    topology     -  filename of topoogy file
    parameters   -  filename of parameters file
    coords       -  after initialization, contains a dictionary 
                   containing entries of
                       (segid,resid) -> "PDB ATOM RECORD"
    coordFilename - filename of PDB containing tag coordinates with
                   optional rotamer weights.
    paraAtomname  - name of paramagnetic atom in tag.
    rigidRegions  - sequence of strings containing names of atoms to
                   grouped in rigid bodies.
attachTag(self, selection, verbose=False)
Attach all tag residues in this TagInfo instance to the residue
specified by the selection argument.
numCopies(self)

Data descriptors inherited from TagDBInfo:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)

 
class TagTool(builtins.object)
    TagTool(tagSimulation=None, selection='not PSEUDO', simName='TagSimulation')
 

 
  Methods defined here:
__init__(self, tagSimulation=None, selection='not PSEUDO', simName='TagSimulation')
FIX
addAtoms(self, tagName, numCopies=None, useCoordLibrary=True, randomizeTorsions=False, resid=1, segid=None, verbose=False)
Add tag atoms to simulation. These are logically separate from
the copies attached to residues, and may be attached to more than
one residue using the attachTag method of the returned TagInfo object. 
 
The numCopies argument specifies the number of tag coordinate
sets to add. A numCopies value of None specifies that all
conformations in the rotamer library are read, if coordinates
are specified, otherwise a single rotamer is generated.
 
The resid parameter specifies resid for all copies of the generated 
tag residue.
 
Copies are distinguished by their segid. The segid (string)
argument specifies the start segid for the newly created tag
atoms. If specified, it should follow this rule: all but the
first character should be digit characters (0-9), else it
defaults to self.defaultSegid. The segid for subsequent copies are 
generated by incrementing the numeric portion of this segid.
 
If randomizeTorsions==True, the tag torsion angles are randomized, so 
that the coordinate library is no longer used.
 
As a side-effect, the [tagResidues] atomSelLang abbrevation is 
updated to include all tag residue atoms, and the [fixedReference] 
abbreviation is updated, if necessary, to contain the [tagResidues]
entries.
 
All added atoms are designated as pseudo atoms for the
atomSelLang specifications.
addTag(self, selection, tagName, numCopies=None, useCoordLibrary=True, randomizeTorsions=False, atomResid=None, atomsExist=False, segid=None, verbose=False)
Add atoms to a simulation, and anchor the tag to an existing
residue identified by the selection argument.
 
This method calls addAtoms if atomsExist=False, and then attachTag. 
If atomResid==None, the resid of the generated tag is that 
corresponding to the selection argument.
create_TagRepel(self, selection='all', termName='tagRepel', bbSel='name CA C N O HN HA* HT* OT*')
Create a repelPot.RepelPot term to prevent intra-tag overlap
and overlap of tag atoms with backbone atoms. The selection argument
can be used to frther restrict included atoms.
placeInFrame(self, tagInfo)
put in canonical reference frame
 attachAtoms[0] is at the origin
 z is along the attachAtoms[1]-attachAtoms[0] vector
 v is along the attachAtoms[2]-attachAtoms[0] vector
potName(self)
segidsResids(self)
Return list of (segid,resid) pairs for all added tags.
simulation(self)
#these methods added s.t. simulationTools.*topoTerm functions can be used
topologySetup(self, ivm)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)

 
Functions
       
doRandomizeTorsions(selection, rigidRegions)
getDBfilename(filename)
Determine whether filename is in local directory or TAGDB, and return
the appropriate path.
topologySetup(ivm, list=[])
Call TagInfo.topologySetup for each instance.
updateDBentry(tagName, attachAtoms=None, topology=None, parameters=None, coords=None, coordsFilename=None, paraAtomname=None, rigidRegions=None)
Update an entry with the given tagName in the tag database. Any other 
entry can be specified.

 
Data
        tagDB = {'CED': <tagTool.TagDBInfo object>, 'R1': <tagTool.TagDBInfo object>}