/usr/share/pyshared/PyMca/PyMcaPlugins/StackPluginBase.py is in pymca 4.5.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | """
A Stack plugin is a module that will be automatically added to the PyMca stack windows
in order to perform user defined operations on the data stack.
These plugins will be compatible with any stack window that provides the functions:
#data related
getStackDataObject
getStackData
getStackInfo
setStack
getStackROIImagesAndNames
#mask related
setStackSelectionMask
getStackSelectionMask
#displayed curves
getActiveCurve
getGraphXLimits
getGraphYLimits
#images
addImage
removeImage
replaceImage
#information method
stackUpdated
selectionMaskUpdated
"""
import weakref
DEBUG = 0
class StackPluginBase(object):
def __init__(self, stackWindow, **kw):
"""
stackWindow is the object instantiating the plugin.
Unless one knows what (s)he is doing, only a proxy should be used.
I pass the actual instance to keep all doors open.
"""
self._stackWindow = weakref.proxy(stackWindow)
pass
#stack related functions
def getStackROIImagesAndNames(self):
return self._stackWindow.getStackROIImagesAndNames()
def getStackDataObject(self):
return self._stackWindow.getStackDataObject()
def getStackData(self):
return self._stackWindow.getStackData()
def getStackInfo(self):
return self._stackWindow.getStackInfo()
def getStackSelectionMask(self):
return self._stackWindow.getSelectionMask()
def setStackSelectionMask(self, mask, instance_id=None):
if instance_id is None:
instance_id = id(self)
return self._stackWindow.setSelectionMask(mask,
instance_id=instance_id)
def setStack(self, *var, **kw):
return self._stackWindow.setStack(*var, **kw)
def addImage(self, image, name):
return self._stackWindow.addImage(image, name)
def removeImage(self, name):
return self._stackWindow.removeImage(name)
def replaceImage(self, image, name):
return self._stackWindow.replaceImage(image, name)
#Plot window related functions
def getActiveCurve(self):
"""
Function to access the currently active curve.
It returns None in case of not having an active curve.
Output has the form:
xvalues, yvalues, legend, dict
where dict is a dictionnary containing curve info.
For the time being, only the plot labels associated to the
curve are warranted to be present under the keys xlabel, ylabel.
"""
return self._stackWindow.getActiveCurve()
def getGraphXLimits(self):
"""
Get the graph X limits.
"""
return self._stackWindow.getGraphXLimits()
def getGraphYLimits(self):
"""
Get the graph Y limits.
"""
return self._stackWindow.getGraphYLimits()
def stackUpdated(self):
if DEBUG:
print("stackUpdated(self) not implemented")
def stackROIImageListUpdated(self):
if DEBUG:
print("stackROIImageListUpdated(self) not implemented")
return
def selectionMaskUpdated(self):
if DEBUG:
print("selectionMaskUpdated(self) not implemented")
#Methods to be implemented by the plugin
def getMethods(self):
"""
A list with the NAMES associated to the callable methods
that are applicable to the specified stack.
"""
print("BASE STACK getMethods not implemented")
return []
def getMethodToolTip(self, name):
"""
Returns the help associated to the particular method name or None.
"""
return None
def getMethodPixmap(self, name):
"""
Returns the pixmap associated to the particular method name or None.
"""
return None
def applyMethod(self, name):
"""
The plugin is asked to apply the method associated to name.
"""
print("applyMethod not implemented")
return
MENU_TEXT = "StackPluginBase"
def getStackPluginInstance(stackWindow, **kw):
ob = StackPluginBase(stackWindow)
return ob
|