Changeset be6f7af in sasview

Timestamp:

Oct 25, 2017 2:50:50 AM (6 years ago)

Author:

Adam Washington <adam.washington@…>

Children:

a3c4217

Parents:

7be7136

Message:

Remove a bunch of pylint

File:

• src/sas/qtgui/Perspectives/Corfunc/CorfuncPerspective.py (modified) (13 diffs)

src/sas/qtgui/Perspectives/Corfunc/CorfuncPerspective.py

@@ +1 @@
+# pylint: disable=E1101
+
 # global
 from PyQt4 import QtCore
@@ -30 +32 @@
 
     def draw_q_space(self):
+        """Draw the Q space data in the plot window
+
+        This draws the q space data in self.data, as well
+        as the bounds set by self.qmin, self.qmax1, and self.qmax2.
+        It will also plot the extrpolation in self.extrap, if it exists."""
+
         self.fig.clf()
 
@@ -53 +61 @@
 
     def draw_real_space(self):
+        """
+        This function draws the real space data onto the plot
+
+        The 1d correlation function in self.data, the 3d correlation function
+        in self.data3, and the interface distribution function in self.data_idf
+        are all draw in on the plot in linear cooredinates."""
         self.fig.clf()
 
@@ -71 +85 @@
 
 class CorfuncWindow(QtGui.QDialog, Ui_CorfuncDialog):
-    # The controller which is responsible for managing signal slots connections
-    # for the gui and providing an interface to the data model.
+    """Displays the correlation function analysis of sas data."""
     name = "Corfunc"  # For displaying in the combo box
 
@@ -81 +94 @@
         self.setWindowTitle("Corfunc Perspective")
 
+        self.mapper = None
         self.model = QtGui.QStandardItemModel(self)
         self.communicate = GuiUtils.Communicate()
         self._calculator = CorfuncCalculator()
+        self._allow_close = True
 
         self._canvas = MyMplCanvas(self.model)
@@ -101 +116 @@
 
     def setup_slots(self):
+        """Connect the buttons to their appropriate slots."""
         self.extrapolateBtn.clicked.connect(self.extrapolate)
         self.transformBtn.clicked.connect(self.transform)
 
-        self.calculateBgBtn.clicked.connect(self.calculateBackground)
-
-        self.model.itemChanged.connect(self.modelChanged)
+        self.calculateBgBtn.clicked.connect(self.calculate_background)
+
+        self.model.itemChanged.connect(self.model_changed)
 
     def setup_model(self):
+        """Populate the model with default data."""
         self.model.setItem(W.W_QMIN,
                            QtGui.QStandardItem("0.01"))
@@ -134 +151 @@
         self.model.setItem(W.W_PERIOD, QtGui.QStandardItem(str(0)))
 
-    def modelChanged(self, item):
+    def model_changed(self, _):
+        """Actions to perform when the data is updated"""
+        if not self.mapper:
+            return
         self.mapper.toFirst()
         self._canvas.draw_q_space()
@@ -147 +167 @@
 
     def extrapolate(self):
+        """Extend the experiemntal data with guinier and porod curves."""
         self._update_calculator()
         params, extrapolation, _ = self._calculator.compute_extrapolation()
@@ -160 +181 @@
 
     def transform(self):
+        """Calculate the real space version of the extrapolation."""
         if self.fourierBtn.isChecked():
             method = "fourier"
@@ -166 +188 @@
 
         extrap = self._canvas.extrap
-        bg = float(self.model.item(W.W_BACKGROUND).text())
-
-        def updatefn(*args, **kwargs):
-            pass
+        background = float(self.model.item(W.W_BACKGROUND).text())
+
+        def updatefn(msg):
+            """Report progress of transformation."""
+            self.communicate.statusBarUpdateSignal.emit(msg)
 
         def completefn(transforms):
+            """Extract the values from the transforms and plot"""
             (trans1, trans3, idf) = transforms
             self._realplot.data = trans1
@@ -192 +216 @@
 
         self._update_calculator()
-        self._calculator.compute_transform(extrap, method, bg,
+        self._calculator.compute_transform(extrap, method, background,
                                            completefn, updatefn)
 
     def setup_mapper(self):
+        """Creating mapping between model and gui elements."""
         self.mapper = QtGui.QDataWidgetMapper(self)
         self.mapper.setOrientation(QtCore.Qt.Vertical)
@@ -219 +244 @@
         self.mapper.toFirst()
 
-    def calculateBackground(self):
+    def calculate_background(self):
+        """Find a good estimate of the background value."""
         self._update_calculator()
-        bg = self._calculator.compute_background()
-        temp = QtGui.QStandardItem(str(bg))
+        background = self._calculator.compute_background()
+        temp = QtGui.QStandardItem(str(background))
         self.model.setItem(W.W_BACKGROUND, temp)
 
@@ -244 +270 @@
             raise AttributeError(msg)
 
-        self._model_item = data_item[0]
-        data = GuiUtils.dataFromItem(self._model_item)
+        model_item = data_item[0]
+        data = GuiUtils.dataFromItem(model_item)
         self._calculator.set_data(data)