Merge pull request #1544 from UV-CDAT/preserve_display_plots

Preserve display plots on update, instead of trashing them all

Author: chaosphere2112

Packages/vcs/vcs/Canvas.py

@@ -2244,13 +2244,13 @@ def drawtextcombined(self, Tt_name=None, To_name=None, string=None,
     # Set alias for the secondary drawtextcombined.
     drawtext = drawtextcombined
 
-    _plot_keywords_ = ['variable', 'grid', 'xaxis', 'yaxis', 'xrev', 'yrev', 'continents', 'xarray', 'yarray',
-                       'name', 'time', 'units', 'ymd', 'file_comment',
-                       'xbounds', 'ybounds', 'xname', 'yname', 'xunits', 'yunits', 'xweights', 'yweights',
-                       'comment1', 'comment2', 'comment3', 'comment4', 'hms', 'long_name', 'zaxis',
-                       'zarray', 'zname', 'zunits', 'taxis', 'tarray', 'tname', 'tunits', 'waxis', 'warray',
-                       'wname', 'wunits', 'bg', 'ratio', 'donotstoredisplay', 'render', 'continents_line']
+    _plot_keywords_ = ['variable', 'grid', 'xaxis', 'xarray',  'xrev', 'yaxis', 'yarray', 'yrev', 'continents',
+                       'xbounds', 'ybounds', 'zaxis', 'zarray', 'taxis', 'tarray', 'waxis', 'warray', 'bg', 'ratio',
+                       'donotstoredisplay', 'render', 'continents_line', "display_name"]
 
+    _deprecated_plot_keywords_ = ["time", "units", "file_comment", "xname", "yname", "zname", "tname", "wname",
+                                  "xunits", "yunits", "zunits", "tunits", "wunits", "comment1", "comment2", "comment3",
+                                  "comment4", "long_name"]
     # def replot(self):
     #    """ Clears and plots with last used plot arguments
     #    """
@@ -2297,28 +2297,10 @@ def plot(self, *actual_args, **keyargs):
             '3',3: y dim will be 3 times bigger than x dim (restricted to original tempalte.data area
             Adding a 't' at the end of the ratio, makes the tickmarks and boxes move along.
 
-    Variable attribute keys:
-       comment1         = string   #Comment plotted above file_comment
-       comment2         = string   #Comment plotted above comment1
-       comment3         = string   #Comment plotted above comment2
-       comment4         = string   #Comment plotted above comment4
-       file_comment     = string   #Comment (defaults to file.comment)
-       hms              = string (hh:mm:ss) #Hour, minute, second
-       long_name        = string   #Descriptive variable name
-       name             = string   #Variable name (defaults to var.id)
-       time             = cdtime   #instance (relative or absolute),
-                                    cdtime, reltime or abstime value
-       units            = string   #Variable units
-       ymd              = string (yy/mm/dd) #Year, month, day
-
     Dimension attribute keys (dimension length=n):
        [x|y|z|t|w]array = NumPy array of length n    # x or y Dimension values
        [x|y|z|t|w]array = NumPy array of length n    # x or y Dimension values
        [x|y]bounds       = NumPy array of shape (n,2) # x or y Dimension boundaries
-       [x|y|z|t|w]name   = string                     # x or y Dimension name
-       [x|y|z|t|w]units  = string                     # x or y Dimension units
-       [x|y]weights      = NumPy array of length n    # x or y Dimension weights (used to
-                                                        calculate area-weighted mean)
 
     CDMS object:
        [x|y|z|t|w]axis   = CDMS axis object           # x or y Axis
@@ -2345,7 +2327,13 @@ def plot(self, *actual_args, **keyargs):
                                                       # Values 6 through 11 signify the line type
                                                       # defined by the files data_continent_other7
                                                       # through data_continent_other12.
-
+        continents_line = vcs.getline("default")    # VCS line object to define continent appearance
+        donotstoredisplay = True|False              # Whether the displayplot object generated by this plot are stored
+        render = True|False                         # Whether to actually render the plot or not (useful for doing a
+                                                    # bunch of plots in a row)
+        display_name = "__display_123"                # VCS Display plot name (used to prevent duplicate display plots)
+        ratio = 1.5|"autot"|"auto"                   # Ratio of height/width for the plot; autot and auto will choose a
+                                                    # "good" ratio for you.
     Graphics Output in Background Mode:
        bg                 = 0|1   # if ==1, create images in the background
                                                              (Don't display the VCS Canvas)
@@ -3464,16 +3452,20 @@ def set_convert_labels(copy_mthd, test=0):
                     "unknown taylordiagram graphic method: %s" %
                     arglist[4])
             t.plot(arglist[0], canvas=self, template=arglist[2], **keyargs)
-            nm, src = self.check_name_source(None, "default", "display")
-            dn = displayplot.Dp(nm)
+
+            dname = keyargs.get("display_name")
+            if dname is not None:
+                dn = vcs.elements["display"][dname]
+            else:
+                nm, src = self.check_name_source(None, "default", "display")
+                dn = displayplot.Dp(nm)
             dn.continents = self.getcontinentstype()
             dn.continents_line = self.getcontinentsline()
             dn.template = arglist[2]
             dn.g_type = arglist[3]
             dn.g_name = arglist[4]
             dn.array = arglist[:2]
             dn.extradisplays = t.displays
-# dn.array=arglist[0]
             for p in slab_changed_attributes.keys():
                 tmp = slab_changed_attributes[p]
                 if tmp == (None, None):
@@ -3502,11 +3494,14 @@ def set_convert_labels(copy_mthd, test=0):
                     doratio == "0" or doratio[:4] == "auto"):
                 doratio = "1t"
             for keyarg in keyargs.keys():
-                if keyarg not in self.__class__._plot_keywords_ + \
-                        self.backend._plot_keywords:
-                    warnings.warn(
-                        'Unrecognized vcs plot keyword: %s, assuming backend (%s) keyword' %
-                        (keyarg, self.backend.type))
+                if keyarg not in self.__class__._plot_keywords_ + self.backend._plot_keywords:
+                    if keyarg in self.__class__._deprecated_plot_keywords_:
+                        warnings.warn("Deprecation Warning: Keyword '%s' will be removed in the next version"
+                                      "of UV-CDAT." % keyarg)
+                    else:
+                        warnings.warn(
+                            'Unrecognized vcs plot keyword: %s, assuming backend (%s) keyword' %
+                            (keyarg, self.backend.type))
 
             if arglist[0] is not None or 'variable' in keyargs:
                 arglist[0] = self._reconstruct_tv(arglist, keyargs)
@@ -3725,9 +3720,13 @@ def set_convert_labels(copy_mthd, test=0):
             else:
                 returned_kargs = self.backend.plot(*arglist, **keyargs)
                 if not keyargs.get("donotstoredisplay", False):
-                    nm, src = self.check_name_source(
-                        None, "default", "display")
-                    dn = displayplot.Dp(nm, parent=self)
+                    dname = keyargs.get("display_name")
+                    if dname is not None:
+                        dn = vcs.elements['display'][dname]
+                    else:
+                        nm, src = self.check_name_source(
+                            None, "default", "display")
+                        dn = displayplot.Dp(nm, parent=self)
                     dn.template = arglist[2]
                     dn.g_type = arglist[3]
                     dn.g_name = arglist[4]
@@ -3872,13 +3871,20 @@ def clear(self, *args, **kargs):
     a.plot(array,'default','isofill','quick')
     a.clear()
 
+  Internally, update() calls clear() to assist in removing plots. The preserve_display argument is used to
+  make sure that the display plots that are associated with the current canvas are not eliminated, and
+  are still able to be used to regenerate the plots.
 """
         if self.animate.created():
             self.animate.close()
         if self.configurator is not None:
             self.configurator.stop_animating()
         self.animate_info = []
         self.animate.update_animate_display_list()
+
+        preserve_display = kargs.get("preserve_display", False)
+        if "preserve_display" in kargs:
+            del kargs["preserve_display"]
         self.backend.clear(*args, **kargs)
         for nm in self.display_names:
             # Lets look at elements created by dispaly production
@@ -3893,7 +3899,8 @@ def clear(self, *args, **kargs):
                     for k in new_elts[e]:
                         if k in vcs.elements[e].keys():
                             del(vcs.elements[e][k])
-            del(vcs.elements["display"][nm])
+            if not preserve_display:
+                del(vcs.elements["display"][nm])
         self.display_names = []
         return
 

Packages/vcs/vcs/VTKPlots.py

@@ -299,23 +299,21 @@ def configureEvent(self, obj, ev):
             parg.append(d.g_type)
             parg.append(d.g_name)
             plots_args.append(parg)
-            kwarg = {}
+            key = {"display_name": dnm}
             if d.ratio is not None:
-                kwarg["ratio"] = d.ratio
+                key["ratio"] = d.ratio
+            key["continents"] = d.continents
+            key["continents_line"] = d.continents_line
+            key_args.append(key)
 
-            kwarg["continents"] = d.continents
-            kwarg["continents_line"] = d.continents_line
-
-            key_args.append(kwarg)
-
-        # Have to pull out the UI layer so it doesn't get borked by the clear
+        # Have to pull out the UI layer so it doesn't get borked by the z
         self.hideGUI()
 
         if self.canvas.configurator is not None:
             restart_anim = self.canvas.configurator.animation_timer is not None
         else:
             restart_anim = False
-        self.canvas.clear(render=False)
+        self.canvas.clear(render=False, preserve_display=True)
 
         for i, pargs in enumerate(plots_args):
             self.canvas.plot(*pargs, render=False, **key_args[i])