Package schrodinger :: Package maestro :: Module markers :: Class Marker
[hide private]
[frames] | no frames]

Class Marker

object --+
         |
        Marker

Class to manipulate a set of markers in the Workspace by ASLs. The only parameter that can be controlled is the color of the marker.

This marker is useful for showing a picked ligand or residue, for example.

Instance Methods [hide private]
 
__init__(self, name=None, asl="NOT all", color=(1,1,1))
Create a Marker object
 
hide(self)
Hide the markers
 
show(self, asl=None)
Show the markers.
 
setVisible(self, show)
Show the marker if <show> is True; hide otherwise.
 
setAsl(self, asl)
Update the ASL of this marker to the given string, without affecting the visibility of it.

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

Class Variables [hide private]
  _name_count = 1
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name=None, asl="NOT all", color=(1,1,1))
(Constructor)

 

Create a Marker object

Parameters:
  • name (str) - The name of the marker group. Used for unique identification of the marker within Maestro. By default a unique string identifier is generated.
  • asl (str) - The ASL defining which atoms should be marked. By default no atoms are marked.
  • red - The amount of red, green, and blue to use, each ranging from 0.0 to 1.0. Default is white (1, 1, 1).
  • color (tuple of 3 floats)
Overrides: object.__init__

show(self, asl=None)

 

Show the markers. If a new ASL is shown, then the previous markers get cleared and the new atoms are marked.

Parameters:
  • asl (str) - The ASL defining which atoms should be marked. This replaces any previous ASL marked by this Marker instance.

setVisible(self, show)

 

Show the marker if <show> is True; hide otherwise. Useful for hooking up to a slot of a QCheckBox.