Add routines to save/restore limits on all plot axes; restore limits after refinement; fix reset of limits on w key; cleanup plot margins

Author: briantoby

GSASII/GSASIIdataGUI.py

@@ -5538,6 +5538,8 @@ def OnRefine(self,event):
         self.SaveTreeSetting() # save the current tree selection
         self.GPXtree.SaveExposedItems()             # save the exposed/hidden tree items
         if self.PatternId and self.GPXtree.GetItemText(self.PatternId).startswith('PWDR '):
+            # true when a pattern is selected for plotting, which includes
+            # when a group is selected.
             refPlotUpdate = G2pwpl.PlotPatterns(self,refineMode=True) # prepare for plot updating
         else:
             refPlotUpdate = None
@@ -9182,7 +9184,7 @@ def OnShowShift(event):
         # if GSASIIpath.GetConfigValue('debug'):
         #     print('Debug: reloading',G2gr)
         #     from importlib import reload
-        #     reload(G2G)
+        #     reload(G2pwpl)
         #     reload(G2gr)
         G2gr.UpdateGroup(G2frame,item)
     elif GSASIIpath.GetConfigValue('debug'):

GSASII/GSASIIplot.py

@@ -325,6 +325,7 @@ def __init__(self,parent,id=-1,G2frame=None):
         self.allowZoomReset = True # this indicates plot should be updated not initialized
                                    # (BHT: should this be in tabbed panel rather than here?)
         self.lastRaisedPlotTab = None
+        self.savedPlotLims = None
 
     def OnNotebookKey(self,event):
         '''Called when a keystroke event gets picked up by the notebook window
@@ -395,7 +396,7 @@ def GetTabIndex(self,label):
     #     if plotNum is not None:
     #         wx.CallAfter(self.SetSelectionNoRefresh,plotNum)
 
-    def FindPlotTab(self,label,Type,newImage=True):
+    def FindPlotTab(self,label,Type,newImage=True,saveLimits=False):
         '''Open a plot tab for initial plotting, or raise the tab if it already exists
         Set a flag (Page.plotInvalid) that it has been redrawn
         Record the name of the this plot in self.lastRaisedPlotTab
@@ -409,6 +410,8 @@ def FindPlotTab(self,label,Type,newImage=True):
 
         :param bool newImage: forces creation of a new graph for matplotlib
           plots only (defaults as True)
+        :param bool saveLimits: When True, limits for all MPL axes (plots)
+          are saved in self.savedPlotLims.
         :returns: new,plotNum,Page,Plot,limits where
 
           * new: will be True if the tab was just created
@@ -417,15 +420,17 @@ def FindPlotTab(self,label,Type,newImage=True):
             the plot appears
           * Plot: the mpl.Axes object for the graphic (mpl) or the figure for
             openGL.
-          * limits: for mpl plots, when a plot already exists, this will be a tuple
-            with plot scaling. None otherwise.
+          * limits: for mpl plots, when a plot already exists, this 
+            will be a tuple with plot scaling. None otherwise. Only appropriate
+            for plots with one set of axes. 
         '''
         limits = None
         Plot = None
         try:
             new = False
             plotNum,Page = self.GetTabIndex(label)
             if Type == 'mpl' or Type == '3d':
+                if saveLimits: self.savePlotLims(Page)
                 Axes = Page.figure.get_axes()
                 Plot = Page.figure.gca()          #get previous plot
                 limits = [Plot.get_xlim(),Plot.get_ylim()] # save previous limits
@@ -469,6 +474,46 @@ def FindPlotTab(self,label,Type,newImage=True):
         Page.toolbar.enableArrows() # Disable Arrow keys if present
         return new,plotNum,Page,Plot,limits
 
+    def savePlotLims(self,Page):
+        '''Make a copy of all the current axes in the notebook object
+        '''
+        self.savedPlotLims = [
+            [i.get_xlim() for i in Page.figure.get_axes()],
+            [i.get_ylim() for i in Page.figure.get_axes()]]
+        #print(f'saved {len(self.savedPlotLims[1])} axes limits')
+
+    def restoreSavedPlotLims(self,Page):
+        '''Restore the plot limits, when previously saved, and when 
+        ``G2frame.restorePlotLimits`` is set to True, which 
+        is done when ``GSASIIpwdplot.refPlotUpdate`` is called with
+        ``restore=True``, which indicates that "live plotting" is done.
+        The restore operation can only be done once, as the limits
+        are deleted after use in this method.
+        '''
+        if self.savedPlotLims is None:
+            #print('---- nothing to restore')
+            return
+        if not hasattr(self.G2frame,'restorePlotLimits'):
+            #print('---- restorePlotLimits not set')
+            return
+        if not self.G2frame.restorePlotLimits:
+            #print('---- restorePlotLimits: not yet')
+            return
+        savedPlotLims = self.savedPlotLims
+        axesList = Page.figure.get_axes()
+        if len(axesList) != len(savedPlotLims[0]):
+            #print('saved lengths differ',len(axesList),len(savedPlotLims[0]))
+            return
+        for i,ax in enumerate(axesList):
+            ax.set_xlim(savedPlotLims[0][i])
+            ax.set_ylim(savedPlotLims[1][i])
+            #print(i,
+            #            savedPlotLims[0][i][0],savedPlotLims[0][i][1],
+            #            savedPlotLims[1][i][0],savedPlotLims[1][i][1])
+        self.savedPlotLims = None
+        self.G2frame.restorePlotLimits = False
+        Page.canvas.draw()
+    
     def _addPage(self,name,page):
         '''Add the newly created page to the notebook and associated lists.
 

GSASII/GSASIIpwdplot.py

@@ -121,20 +121,6 @@ def ReplotPattern(G2frame,newPlot,plotType,PatternName=None,PickName=None):
     G2frame.Extinct = [] # array of extinct reflections
     PlotPatterns(G2frame,plotType=plotType)
 
-def plotVline(Page,Plot,Lines,Parms,pos,color,pickrad,style='dotted'):
-    '''shortcut to plot vertical lines for limits & Laue satellites.
-    Was used for extrapeaks'''
-    if not pickrad: pickrad = 0.0
-    if Page.plotStyle['qPlot']:
-        Lines.append(Plot.axvline(2.*np.pi/G2lat.Pos2dsp(Parms,pos),color=color,
-            picker=pickrad,linestyle=style))
-    elif Page.plotStyle['dPlot']:
-        Lines.append(Plot.axvline(G2lat.Pos2dsp(Parms,pos),color=color,
-            picker=pickrad,linestyle=style))
-    else:
-        Lines.append(Plot.axvline(pos,color=color,
-            picker=pickrad,linestyle=style))
-        
 def PlotPatterns(G2frame,newPlot=False,plotType='PWDR',data=None,
                      extraKeys=[],refineMode=False,indexFrom='',fromTree=False):
     '''Powder pattern plotting package - displays single or multiple powder 
@@ -209,7 +195,7 @@ def OnPlotKeyPress(event):
                 G2frame.SinglePlot = True
             elif 'PWDR' in plottype: # Turning on Weight plot clears previous limits
                 G2frame.FixedLimits['dylims'] = ['','']                
-            newPlot = True
+            #newPlot = True # this resets the x & y limits, not wanted!
         elif event.key in ['shift+1','!']: # save current plot settings as defaults
             # shift+1 assumes US keyboard
             print('saving plotting defaults for',G2frame.GPXtree.GetItemText(G2frame.PatternId))
@@ -1501,15 +1487,19 @@ def onPlotFormat(event):
     def refPlotUpdate(Histograms,cycle=None,restore=False):
         '''called to update an existing plot during a Rietveld fit; it only 
         updates the curves, not the reflection marks or the legend. 
-        It should be called with restore=True to reset plotting 
-        parameters after the refinement is done.
+        After the refinement is complete it is called with restore=True to
+        reset plotting parameters.
 
-        Note that the Page.plotStyle values are stashed in G2frame
-        to be restored later
+        Note that the ``Page.plotStyle`` values are stashed in 
+        ``G2frame.savedPlotStyle`` to be restored after FindPlotTab is 
+        called and ``G2frame.restorePlotLimits`` is set so that 
+        saved plot limits will be applied when 
+        ``G2frame.G2plotNB.restoreSavedPlotLims`` is called.
         '''
         if restore:
             (G2frame.SinglePlot,G2frame.Contour,G2frame.Weight,
                 G2frame.plusPlot,G2frame.SubBack,G2frame.savedPlotStyle) = savedSettings
+            G2frame.restorePlotLimits = True
             return
 
         if plottingItem not in Histograms:
@@ -1724,11 +1714,15 @@ def drawTicks(Phases,phaseList,group=False):
                                     picker=3.,
                                     label='_FLT_'+phase,lw=0.5)
 
-    # Callback used to update y-limits when user zooms interactively (MG/Cl Sonnet)
+    # Callback used to update y-limits when user zooms interactively (from MG/Cl Sonnet)
     def onGroupXlimChanged(ax):
-        '''Callback to update y-limits for all panels when x-range changes.
+        '''Callback to update y-limits for all panels in group plot when x-range changes.
         We calculate the global y-range across all panels for the visible x-range,
         then explicitly set y-limits on ALL panels.
+        
+        This currently allows the y-limit to be set manually for one plot. If
+        a second one is changed, the previous manual change is lost.
+        I wonder if we can identify which plots have manual changes.
         '''
         xlim = ax.get_xlim()
         # Save x-limits for persistence across refinements
@@ -1831,10 +1825,11 @@ def onGroupXlimChanged(ax):
         publish = None
     if G2frame.Contour: publish = None
 
-    new,plotNum,Page,Plot,limits = G2frame.G2plotNB.FindPlotTab('Powder Patterns','mpl')
+    new,plotNum,Page,Plot,limits = G2frame.G2plotNB.FindPlotTab(
+        'Powder Patterns','mpl',saveLimits=refineMode)
     if hasattr(G2frame, 'savedPlotStyle'):
         Page.plotStyle.update(G2frame.savedPlotStyle)
-        del G2frame.savedPlotStyle  # do this only once
+        del G2frame.savedPlotStyle  # do this only once & after Page is defined
     Page.toolbar.setPublish(publish)
     Page.toolbar.arrows['_groupMode'] = None
     # if we are changing histogram types (including group to individual, reset plot)
@@ -2338,13 +2333,12 @@ def onGroupXlimChanged(ax):
             right=.99,top=1.-3/200.,hspace=0,wspace=0)
 
         # Connect callback for all panels when sharedX is enabled
+        up,down = adjustDim(0,Page.groupN)
         if (plotOpt['sharedX'] and 
                         (Page.plotStyle['qPlot'] or Page.plotStyle['dPlot'])):
-            up, down = adjustDim(0, Page.groupN)
             Plots[up].callbacks.connect('xlim_changed', onGroupXlimChanged)
 
         # pretty up the tick labels
-        up,down = adjustDim(0,Page.groupN)
         Plots[up].tick_params(axis='y', direction='inout', left=True, right=True)
         Plots[down].tick_params(axis='y', direction='inout', left=True, right=True)
         if Page.groupN > 1:
@@ -2479,7 +2473,8 @@ def onGroupXlimChanged(ax):
             up,down = adjustDim(0,Page.groupN)
             G2frame.groupXlim = Plots[up].get_xlim()
         Page.canvas.draw()
-        return
+        wx.CallLater(100,G2frame.G2plotNB.restoreSavedPlotLims,Page)  # restore limits to previous, if saved
+        return # end of group plot
     elif G2frame.Weight and not G2frame.Contour:
         Plot.set_visible(False)         #hide old plot frame, will get replaced below
         GS_kw = {'height_ratios':[4, 1],}
@@ -2489,10 +2484,10 @@ def onGroupXlimChanged(ax):
         #     Plot,Plot1 = MPLsubplots(Page.figure, 2, 1, sharex=True, gridspec_kw=GS_kw)
         Plot1.set_ylabel(r'$\mathsf{\Delta(I)/\sigma(I)}$',fontsize=16)
         Plot1.set_xlabel(xLabel,fontsize=16)
-        Page.figure.subplots_adjust(left=16/100.,bottom=16/150.,
-            right=.98,top=1.-16/200.,hspace=0)
     else:
         Plot.set_xlabel(xLabel,fontsize=16)
+    Page.figure.subplots_adjust(left=8/100.,bottom=16/150.,
+            right=.98,top=1.-8/100.,hspace=0,wspace=0)
     if not G2frame.Contour:
         Page.toolbar.enableArrows('',(PlotPatterns,G2frame))
     if G2frame.Weight and G2frame.Contour:
@@ -3293,7 +3288,10 @@ def onGroupXlimChanged(ax):
             G2frame.dataWindow.moveTickSpc.Enable(True)
         if DifLine[0]:
             G2frame.dataWindow.moveDiffCurve.Enable(True)
-    if refineMode: return refPlotUpdate
+    if refineMode:
+        return refPlotUpdate
+    else:
+        wx.CallLater(100,G2frame.G2plotNB.restoreSavedPlotLims,Page)  # restore limits to previous, if saved
 
 def PublishRietveldPlot(G2frame,Pattern,Plot,Page,reuse=None):
     '''Creates a window to show a customizable "Rietveld" plot. Exports that 
@@ -4810,3 +4808,17 @@ def StyleChange(*args):
     mainSizer.Fit(dlg)
     dlg.ShowModal()
     StyleChange()
+
+def plotVline(Page,Plot,Lines,Parms,pos,color,pickrad,style='dotted'):
+    '''shortcut to plot vertical lines for limits & Laue satellites.
+    Was used for extrapeaks'''
+    if not pickrad: pickrad = 0.0
+    if Page.plotStyle['qPlot']:
+        Lines.append(Plot.axvline(2.*np.pi/G2lat.Pos2dsp(Parms,pos),color=color,
+            picker=pickrad,linestyle=style))
+    elif Page.plotStyle['dPlot']:
+        Lines.append(Plot.axvline(G2lat.Pos2dsp(Parms,pos),color=color,
+            picker=pickrad,linestyle=style))
+    else:
+        Lines.append(Plot.axvline(pos,color=color,
+            picker=pickrad,linestyle=style))