Changeset 2453 for trunk/python

Timestamp:

03/31/12 01:22:43 (13 years ago)

Author:

Kana Sugimoto

Message:

New Development: No

JIRA Issue: Yes (CAS-3749/Trac-266)

Ready for Test: Yes

Interface Changes: Yes

What Interface Changed: renamed a parameter of asapplotter._assert_plotter from mode to action

Test Programs:

Put in Release Notes: No

Module(s):

Description: renamed a parameter of asapplotter._assert_plotter from mode to action

Location:

trunk/python

Files:

• asapplotter.py (modified) (20 diffs)
• flagplotter.py (modified) (1 diff)
• interactivemask.py (modified) (1 diff)

trunk/python/asapplotter.py

@@ -121 +121 @@
         return False
 
-    def _assert_plotter(self,mode="status",errmsg=None):
-        """
-        Check asaplot status. Returns True if plot window is alive.
+    def _assert_plotter(self,action="status",errmsg=None):
+        """
+        Check plot window status. Returns True if plot window is alive.
         Parameters
-            mode:      Mode of operation. ['status'|'reload'|'halt']
-                       The mode 'status' simply returns if asaplot is
-                       alive (True/False). When asaplot is not alive,
-                       asaplot is reloaded when mode='reload', while
-                       an error raised when mode='halt' 
+            action:    An action to take if the plotter window is not alive.
+                       ['status'|'reload'|'halt']
+                       The action 'status' simply returns False if asaplot
+                       is not alive. When action='reload', plot window is
+                       reloaded and the method returns True. Finally, an
+                       error is raised when action='halt'.
             errmsg:    An error (warning) message to send to the logger,
-                       when asaplot is dead.        
+                       when plot window is not alive.
         """
         if self._plotter and not self._plotter.is_dead:
@@ -140 +141 @@
             haltmsg = errmsg
         
-        if mode.upper().startswith("R"):
+        if action.upper().startswith("R"):
             # reload plotter
             self._reload_plotter()
             return True
-        elif mode.upper().startswith("H"):
+        elif action.upper().startswith("H"):
             # halt
             asaplog.push(haltmsg)
@@ -176 +177 @@
         self._panelrows = []
 
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if self.casabar_exists():
             self._plotter.figmgr.casabar.set_pagecounter(1)
@@ -199 +200 @@
     def gca(self):
         errmsg = "No axis to retun. Need to plot first."
-        if not self._assert_plotter(mode="status",errmsg=errmsg):
+        if not self._assert_plotter(action="status",errmsg=errmsg):
             return None
         return self._plotter.figure.gca()
@@ -206 +207 @@
         """Do a soft refresh"""
         errmsg = "No figure to re-plot. Need to plot first."
-        self._assert_plotter(mode="halt",errmsg=errmsg)
+        self._assert_plotter(action="halt",errmsg=errmsg)
 
         self._plotter.figure.show()
@@ -221 +222 @@
         """
         ## this method relies on already plotted figure
-        if not self._assert_plotter(mode="status") or (self._data is None):
+        if not self._assert_plotter(action="status") or (self._data is None):
             msg = "Cannot create mask interactively on plot. Can only create mask after plotting."
             asaplog.push( msg )
@@ -271 +272 @@
     # forwards to matplotlib axes
     def text(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -281 +282 @@
 
     def arrow(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -294 +295 @@
 
     def annotate(self, text, xy=None, xytext=None, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -306 +307 @@
 
     def axvline(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -316 +317 @@
 
     def axhline(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -326 +327 @@
 
     def axvspan(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -341 +342 @@
 
     def axhspan(self, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         if kwargs.has_key("interactive"):
             if kwargs.pop("interactive"):
@@ -356 +357 @@
 
     def _axes_callback(self, axesfunc, *args, **kwargs):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         panel = 0
         if kwargs.has_key("panel"):
@@ -786 +787 @@
         """
         errmsg = "Cannot plot spectral lines. Need to plot scantable first."
-        self._assert_plotter(mode="halt",errmsg=errmsg)
+        self._assert_plotter(action="halt",errmsg=errmsg)
         if not self._data:
             raise RuntimeError("No scantable has been plotted yet.")
@@ -865 +866 @@
         """
         errmsg = "Cannot save figure. Need to plot first."
-        self._assert_plotter(mode="halt",errmsg=errmsg)
+        self._assert_plotter(action="halt",errmsg=errmsg)
         
         self._plotter.save(filename,orientation,dpi)
@@ -1388 +1389 @@
     @asaplog_post_dec
     def plottp(self, scan=None, outfile=None):
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         self._plotter.hold()
         self._plotter.clear()
@@ -1478 +1479 @@
         See the method help for detailed information.
         """
-        self._assert_plotter(mode="reload")
+        self._assert_plotter(action="reload")
         self._plotter.text(*args, **kwargs)
     # end matplotlib.Figure.text forwarding function
@@ -1518 +1519 @@
         if plot:
             errmsg = "Can plot header only after the first call to plot()."
-            self._assert_plotter(mode="halt",errmsg=errmsg)
+            self._assert_plotter(action="halt",errmsg=errmsg)
             self._plotter.hold()
             self._header_plot(headstr,fontsize=fontsize)
@@ -1551 +1552 @@
             asaplog.push("No header has been plotted. Exit without any operation")
             asaplog.post("WARN")
-        elif self._assert_plotter(mode="status"):
+        elif self._assert_plotter(action="status"):
             self._plotter.hold()
             for textobj in self._headtext['textobj']:

trunk/python/flagplotter.py

@@ -27 +27 @@
         self._scan = None
         asapplotter.__init__(self,visible=visible, **kwargs)
-        self._assert_plotter(mode='reload')
+        self._assert_plotter(action='reload')
         self._plotter._set_window_title('Flag Plotter')
         self._panelling = 'r'

trunk/python/interactivemask.py

@@ -163 +163 @@
             self.p = asapplotter()
             self.newplot = True
-        self.p._assert_plotter(mode='reload')
+        self.p._assert_plotter(action='reload')
         
         # Plot selected spectra if needed