Trees       Indices       Help   
2016-4 Schrodinger Python API
Package schrodinger :: Package application :: Package bioluminate :: Module workspacelabeler :: Class WorkspaceLabeler
[hide private]
[frames] | no frames]

Class WorkspaceLabeler

object --+
         |
        WorkspaceLabeler

Class with methods for manipulating workspace atom labels.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
 
resetLabelOptions(self)
Resets Maestro's internally persistent label options to ensure consistent behavior of the labeler regardless of intervening calls to the Maestro command 'labelatom' that might change label options.
 
saveLabelOptions(self, options=None)
Saves the state of all of Maestro's 'labelatom' options, generally for the purpose of changing the label options by the WorkspaceLabeler class or by other Python scripts and then changing them back to their original state.
 
restoreLabelOptions(self, options=None)
Restores the state of all of Maestro's 'labelatom' options from a dictionary, generally for the purpose of restoring them to their original state.
 
labelAtoms(self, asl, options='atomname=TRUE')
Labels the specified atoms.
 
clearLabels(self, asl)
Deletes all labels from the specified atoms.
 
labelResidues(self, asl, options='resname=TRUE resnum=TRUE')
Labels the alpha carbon of every residue that has at least one atom in the specified ASL.
 
labelChains(self, asl, options='chain=TRUE')
Labels the first and last alpha carbon within the specified ASL of each chain that has at least one atom specified by the ASL.
 
hideLabels(self, asl)
Hides the labels on the specified atoms.
 
showLabels(self, asl)
Unhides previously hidden labels on the specified atoms.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

resetLabelOptions(self)

 

Resets Maestro's internally persistent label options to ensure consistent behavior of the labeler regardless of intervening calls to the Maestro command 'labelatom' that might change label options. It is generally not necessary to use this command; however it could be useful when invoking custom 'labelatom' commands.

saveLabelOptions(self, options=None)

 

Saves the state of all of Maestro's 'labelatom' options, generally for the purpose of changing the label options by the WorkspaceLabeler class or by other Python scripts and then changing them back to their original state.

Parameters:
  • options (dict) - dictionary containing a set of options and values

    Default: saved_options

restoreLabelOptions(self, options=None)

 

Restores the state of all of Maestro's 'labelatom' options from a dictionary, generally for the purpose of restoring them to their original state.

Parameters:
  • options (dict) - dictionary containing a set of options and values

    Default: saved_options

labelAtoms(self, asl, options='atomname=TRUE')

 

Labels the specified atoms. By default labelAtoms will label with atomname, but the label content can be customized with the options parameter.

Parameters:
  • asl (str) - ASL string specifying atoms to label
  • options (str) - An options string that will be passed to the Maestro command 'labelatom' to specify the labeling behavior. See the Maestro Command Reference for full documentation.

    Default: 'atomname=TRUE'

clearLabels(self, asl)

 

Deletes all labels from the specified atoms.

Parameters:
  • asl (str) - ASL string specifying atoms to remove labels from

labelResidues(self, asl, options='resname=TRUE resnum=TRUE')

 

Labels the alpha carbon of every residue that has at least one atom in the specified ASL. This means that labels may be added to atoms that are outside the ASL.

By default labelAtoms will label each CA with the 3-letter residue code and residue number, but the label content can be customized with the options parameter.

Parameters:
  • asl (str) - ASL string specifying atoms that are in residues to label
  • options (str) - An options string that will be passed to the Maestro command 'labelatom' to specify the labeling behavior. See the Maestro Command Reference for full documentation.

    Default: 'resname=TRUE resnum=TRUE'

labelChains(self, asl, options='chain=TRUE')

 

Labels the first and last alpha carbon within the specified ASL of each chain that has at least one atom specified by the ASL. First and last CA are determined by residue numbering.

By default, labelChains will label each of the two CA's with the chain name, but the label content can be customized with the options paramter.

Parameters:
  • asl (str) - ASL string specifying atoms that are in residues to label
  • options (str) - An options string that will be passed to the Maestro command 'labelatom' to specify the labeling behavior. See the Maestro Command Reference for full documentation.

    Default: 'chain=TRUE'

hideLabels(self, asl)

 

Hides the labels on the specified atoms. The difference between hideLabels() and clearLabels() is that labels that have been hidden can be unhidden. Any time a hidden label is replaced or updated, the new label is visible, as in PyMol. Hidden labels can also be cleared; they do not then reappear on showLabels().

Parameters:
  • asl (str) - ASL string specifying atoms to hide labels on

showLabels(self, asl)

 

Unhides previously hidden labels on the specified atoms.

Parameters:
  • asl (str) - ASL string specifying atoms to unhide labels on

   Trees       Indices       Help   
2016-4 Schrodinger Python API
Generated by Epydoc 3.0.1 on Wed Oct 26 00:59:39 2016 http://epydoc.sourceforge.net