Changeset 204f628 in sasview for src/sas/sasgui/perspectives/corfunc

Timestamp:

Aug 23, 2016 2:22:47 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:

839e5e3

Parents:

f56770ef

Message:

Add comments/docstrings

Location:

src/sas/sasgui/perspectives/corfunc

Files:

• corfunc.py (modified) (4 diffs)
• corfunc_panel.py (modified) (5 diffs)

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

@@ -167 +167 @@
             group_id = GROUP_ID_IQ_DATA
             if label == IQ_EXTRAPOLATED_DATA_LABEL:
+                # Show the extrapolation as a curve instead of points
                 new_plot.symbol = GUIFRAME_ID.CURVE_SYMBOL_NUM
         elif label == TRANSFORM_LABEL:
@@ -172 +173 @@
             new_plot.yaxis("{\\Gamma}", '')
             group_id = GROUP_ID_TRANSFORM
+            # Show the transformation as a curve instead of points
             new_plot.symbol = GUIFRAME_ID.CURVE_SYMBOL_NUM
         new_plot.id = label
@@ -188 +190 @@
                 leftdown=True)
         if label == IQ_EXTRAPOLATED_DATA_LABEL:
+            # Zoom in to the region we're interested in
             xlim = (min(self.corfunc_panel._extrapolated_data.x), self.corfunc_panel.qmax[1]*1.2)
             wx.CallAfter(wx.PostEvent, self.parent, PlotLimitEvent(id=IQ_DATA_LABEL, group_id=GROUP_ID_IQ_DATA, xlim=xlim))
@@ -202 +205 @@
             return
         data = panel.plots[panel.graph.selected_plottable]
-        print "Data id is: {}".format(data.id)
         self.set_data([data])

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

@@ -178 +178 @@
 
     def radio_changed(self, event=None):
+        """
+        Called when the "Transform type" radio button are changed
+        """
         if event is not None:
             self.transform_type = event.GetEventObject().GetName()
@@ -275 +278 @@
 
     def extract_parameters(self, event=None):
+        """
+        Called when "Extract Parameters" is clicked
+        """
         try:
             params = self._calculator.extract_parameters(self._transformed_data)
@@ -329 +335 @@
 
     def set_extrapolation_params(self, params=None):
+        """
+        Displays the value of the parameters calculated in the extrapolation
+        """
         if params is None:
             # Reset outputs
@@ -341 +350 @@
 
     def set_extracted_params(self, params=None, reset=False):
+        """
+        Displays the values of the parameters extracted from the Fourier
+        transform
+        """
         self.extracted_params = params
         error = False
@@ -369 +382 @@
 
     def _compute_background(self, event=None):
+        """
+        Compute the background level based on the position of the upper q bars
+        """
         if event is not None:
             event.Skip()