Package schrodinger :: Package application :: Package desmond :: Module fep_scholar_util :: Class MappingAnnotator
[hide private]
[frames] | no frames]

Class MappingAnnotator

               object --+            
                        |            
        sip.simplewrapper --+        
                            |        
                  sip.wrapper --+    
                                |    
infra._canvas2d.ChemViewAnnotator --+
                                    |
                                   MappingAnnotator

This annotator allows to show atom numbers for a selected subset of atoms. In addition user can specify 'map to' list of atom numbers that will be used instead to as atom labels.

Instance Methods [hide private]
 
__init__(self, matches, map_to=None)
Instantiate a MappingAnnotator instance.
 
annotate(self, view, dm)
Add atom number to each atom

Inherited from sip.simplewrapper: __new__

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, matches, map_to=None)
(Constructor)

 

Instantiate a MappingAnnotator instance.

Parameters:
  • matches (list) - list of atoms for which atom labels will be shown.
  • map_to (list) - list of atom numbers that will be used as atom labels. Atom indices in this list are zero-based.
Overrides: object.__init__

annotate(self, view, dm)

 

Add atom number to each atom

Parameters:
  • view (Chemview) - the View this item goes in
  • dm (ChmDrawMol) - object that contains the list of atom and bond graphics
Overrides: infra._canvas2d.ChemViewAnnotator.annotate