Changeset b697396b in sasview

Timestamp:

Apr 5, 2017 11:41:47 AM (8 years ago)

Author:

krzywon

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

0d8ee36

Parents:

1661cd5

git-author:

Jeff Krzywon <krzywon@…> (04/05/17 11:41:47)

git-committer:

krzywon <krzywon@…> (04/05/17 11:41:47)

Message:

Check all items in the list box by default. More documentation.

File:

• src/sas/sasgui/guiframe/local_perspectives/plotting/parameters_panel_slicer.py (modified) (7 diffs)

src/sas/sasgui/guiframe/local_perspectives/plotting/parameters_panel_slicer.py

@@ -4 +4 @@
 import wx.lib.newevent
 import time
-#from copy import deepcopy
 from sas.sasgui.guiframe.events import EVT_SLICER_PARS
 from sas.sasgui.guiframe.utils import format_number
@@ -139 +138 @@
                          wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
             iy += 1
+            # Create a list box with all of the 2D plots
             self.process_list()
             self.bck.Add(self.data_list, (iy, ix), (1, 1),
                          wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
             iy += 1
+            # Button to start batch slicing
             button_label = "Apply Slicer to Selected Plots"
             self.batch_slicer_button = wx.Button(parent=self,
@@ -149 +150 @@
             self.bck.Add(self.batch_slicer_button, (iy, ix), (1, 1),
                              wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
-            # TODO: Select all button
             # TODO: Check box for saving file
             # TODO: append to file information and file type
@@ -206 +206 @@
         type = self.type_select.GetStringSelection()
 
-        # Find loaded 2D data panels
+        # Find desired 2D data panels
         for key, mgr in spp.plot_panels.iteritems():
             if mgr.graph.prop['title'] in self.data_list.CheckedStrings:
                 apply_to_list.append(mgr)
 
-        # Apply slicer to selected panels
+        # Apply slicer type to selected panels
         for item in apply_to_list:
             self._apply_slicer_to_plot(item, type)
 
+        # Post an event to apply appropriate slicer params to each slicer
+        # Event needed due to how apply_slicer_to_plot works
         event = ApplyParams(params=params, plot_list=apply_to_list)
         wx.PostEvent(self, event)
-
         # TODO: save file (if desired)
         # TODO: send to fitting (if desired)
@@ -233 +234 @@
         :param plot: 2D plot panel to apply a slicer to
         :param type: The type of slicer to apply to the panel
-        :return: Return the plot with the slicer applied
         """
         if type is None:
@@ -247 +247 @@
 
     def process_list(self):
+        """
+        Populate the check list from the currently plotted 2D data
+        """
         self.checkme = None
         main_window = self.parent.parent
         self.loaded_data = []
         id = wx.NewId()
+        # Iterate over the loaded plots and find all 2D panels
         for key, value in main_window.plot_panels.iteritems():
             if isinstance(value, ModelPanel2D):
                 self.loaded_data.append(value.data2D.name)
                 if value.data2D.id == self.parent.data2D.id:
+                    # Set current plot panel as uncheckable
                     self.checkme = self.loaded_data.index(value.data2D.name)
         self.data_list = wx.CheckListBox(parent=self, id=id,
                                          choices=self.loaded_data,
                                          name="Apply Slicer to 2D Plots:")
-        if self.checkme is not None:
-            self.data_list.Check(self.checkme)
+        # Check all items bty default
+        for item in range(len(self.data_list.Items)):
+            self.data_list.Check(item)
         self.data_list.Bind(wx.EVT_CHECKLISTBOX, self.onCheckBoxList)
 
     def onCheckBoxList(self, e):
         """
-        Do not allow a checkbox to be unchecked
+        Prevent a checkbox item from being unchecked
         :param e: Event triggered when a checkbox list item is checked
         """
@@ -273 +279 @@
 
     def apply_params_list(self, evt=None):
+        """
+        Event based parameter setting.
+        :param evt: Event triggered to apply parameters to a list of plots
+                    evt should have attrs plot_list and params
+        """
+        # Apply parameter list to each plot as desired
         for item in evt.plot_list:
             item.slicer.set_params(evt.params)
             item.slicer.base.update()
+        # Close the slicer window
         self.Destroy()