Package Pmv :: Module colorCommands :: Class ColorByProperties

Class ColorByProperties

ViewerFramework.VFCommand.Command --+        
                                    |        
                  mvCommand.MVCommand --+    
                                        |    
                             ColorCommand --+
                                            |
                                           ColorByProperties

Known Subclasses:: ColorByExpression


    Command to color the current selection according to the integer
    or float properties, or by defining a function.
    
Package : Pmv
    
Module  : colorCommands
    
Class   : ColorByProperties
    
Command : colorByProperties
    
Synopsis:

      None <- colorByProperties(nodes, geomsToColor, property,colormap='rgb256', **kw)

      nodes --- any set of MolKit nodes describing molecular components

      geomsToColor --- list of the name of geometries to color default is 'all'

      property ---  property name of type integer or float or property defined by a function returning a list of float or int.

      colormap ---  either a string representing a colormap or a DejaVu.ColorMap instance.

Instance Methods

[hide private]

__init__(self, func=None)

onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.

updateLevel_cb(self, tag)

getPropValues(self, nodes, prop, propertyLevel=None)

loadCM_cb(self, event=None)
Callback to load a new color map file.

updateCM(self, event=None)

updateMiniMaxi(self, cmName, event=None)

updateValMinMax(self, event=None)

entryValidate(self, text)

buildFormDescr(self, formName)
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.

updateChooser(self, selection)

guiCallback(self)

cmGUI_cb(self, geomsToColor, property, colormap, propertyLevel=None)

setupUndoBefore(self, nodes, geomsToColor, property, propertyLevel=None, colormap='RGBARamp', mini=None, maxi=None)
This method builds the self.undoCmds string.

doit(self, nodes, geomsToColor, property, propertyLevel=None, colormap=None, mini='not passed', maxi='not passed')
virtual method.

colorProp(self, nodes, geomsToColor, selectioncol, propertyLevel=None)

__call__(self, nodes, geomsToColor, property, propertyLevel=None, colormap='rgb256', mini=None, maxi=None, **kw)
None <- colorByProperty(nodes, geomsToColor, property,colormap='rgb256', **kw)

Inherited from ColorCommand: addNewEntries, cleanup, color_cb, deselectall_cb, dismiss_cb, getAvailableGeoms, getChildrenGeomsName, getNodes, selectall_cb, showForm, showUndisplayed_cb

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildLogArgList, checkDependencies, customizeGUI, doitWrapper, getArguments, getHelp, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, tkCb, updateGeom, warningMsg

Class Variables

[hide private]

levelOrder = {'Residue': 1, 'Molecule': 3, 'Chain': 2, 'Atom': 0}

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly

Method Details

Class ColorByProperties

__init__(self, func=None) (Constructor)

onAddCmdToViewer(self)

updateLevel_cb(self, tag)

getPropValues(self, nodes, prop, propertyLevel=None)

loadCM_cb(self, event=None)

updateCM(self, event=None)

updateMiniMaxi(self, cmName, event=None)

updateValMinMax(self, event=None)

entryValidate(self, text)

buildFormDescr(self, formName)

updateChooser(self, selection)

guiCallback(self)

cmGUI_cb(self, geomsToColor, property, colormap, propertyLevel=None)

setupUndoBefore(self, nodes, geomsToColor, property, propertyLevel=None, colormap='RGBARamp', mini=None, maxi=None)

doit(self, nodes, geomsToColor, property, propertyLevel=None, colormap=None, mini='not passed', maxi='not passed')

colorProp(self, nodes, geomsToColor, selectioncol, propertyLevel=None)

__call__(self, nodes, geomsToColor, property, propertyLevel=None, colormap='rgb256', mini=None, maxi=None, **kw) (Call operator)

levelOrder

init(self, func=None)
(Constructor)

call(self, nodes, geomsToColor, property, propertyLevel=None, colormap='rgb256', mini=None, maxi=None, **kw)
(Call operator)