Changeset 9c90cf3 in sasview

Timestamp:

Jul 11, 2016 2:36:55 AM (8 years ago)

Author:

lewis

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.1.1, release-4.1.2, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

b564ea2

Parents:

e02d8f6

git-author:

Lewis O'Driscoll <lewis.o'driscoll@…> (07/06/16 09:35:07)

git-committer:

Lewis O'Driscoll <lewis.o'driscoll@…> (07/11/16 02:36:55)

Message:

Minor refactor and add some comments

Location:

src/sas/sasgui/perspectives/corfunc

Files:

• corfunc.py (modified) (2 diffs)
• corfunc_panel.py (modified) (4 diffs)
• corfunc_state.py (modified) (3 diffs)

src/sas/sasgui/perspectives/corfunc/corfunc.py

@@ -32 +32 @@
         logging.info("Correlation function plug-in started")
         self._always_active = True
-
         self.state_reader = Reader(self.set_state)
         self._extensions = '.cor'
@@ -138 +137 @@
         new_plot.id = self.data_id
         new_plot.title = "I(q)"
+        # Show data on a linear scale
         new_plot.xtransform = 'x'
         new_plot.ytransform = 'y'

src/sas/sasgui/perspectives/corfunc/corfunc_panel.py

@@ -52 +52 @@
 
     def set_state(self, state=None, data=None):
+        """
+        Set the state of the panel. If no state is provided, the panel will
+        be set to the default state.
+
+        :param state: A CorfuncState object
+        :param data: A Data1D object
+        """
         if state is None:
             self.state = CorfuncState()
@@ -109 +116 @@
         """
         Return an XML node containing the state of the panel
+
+        :param doc: Am xml node to attach the project state to (optional)
         """
         data = self._data
@@ -123 +132 @@
                     doc = new_doc
         return doc
+
+    def set_qmin(self, qmin):
+        self.qmin = qmin
+        self._qmin_input.SetValue(str(qmin))
+
+    def set_qmax(self, qmax):
+        self.qmax = qmax
+        self._qmax1_input.SetValue(str(qmax[0]))
+        self._qmax2_input.SetValue(str(qmax[1]))
 
 
@@ -145 +163 @@
                 active=event.GetEventObject(), id=data_id, group_id=group_id,
                 leftdown=False))
-
-    def set_qmin(self, qmin):
-        self.qmin = qmin
-        self._qmin_input.SetValue(str(qmin))
-
-    def set_qmax(self, qmax):
-        self.qmax = qmax
-        self._qmax1_input.SetValue(str(qmax[0]))
-        self._qmax2_input.SetValue(str(qmax[1]))
 
     def _validate_qrange(self):

src/sas/sasgui/perspectives/corfunc/corfunc_state.py

@@ -1 @@
-"""
-State class for the corfunc UI
-"""
 import time
 import sys
@@ -35 +32 @@
 
 class CorfuncState(object):
+    """
+    Stores information about the state of CorfuncPanel
+    """
 
     def __init__(self):
@@ -206 +206 @@
 class Reader(CansasReader):
     """
-    Class to read a CanSAS file containing the state of the CorfuncPanel
+    Reads a CanSAS file containing the state of a CorfuncPanel
     """