Changeset 6970e51 in sasview for src/sas/sascalc/corfunc

Timestamp:

Jul 11, 2016 4: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:

dc72638

Parents:

54a0989

git-author:

Lewis O'Driscoll <lewis.o'driscoll@…> (07/07/16 12:05:12)

git-committer:

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

Message:

Add some docstrings

File:

• src/sas/sascalc/corfunc/corfunc_calculator.py (modified) (3 diffs)

src/sas/sascalc/corfunc/corfunc_calculator.py

@@ -109 +109 @@
 
     def compute_extrapolation(self):
+        """
+        Extrapolate and interpolate scattering data
+
+        :return: The extrapolated data
+        """
         q = self._data.x
         iq = self._data.y
@@ -123 +128 @@
         """
         Transform an extrapolated scattering curve into a correlation function.
+
+        :param extrapolation: The extrapolated data
+        :param background: The background value (if not provided, previously
+            calculated value will be used)
+        :return: The transformed data
         """
         qs = extrapolation.x
@@ -154 +164 @@
 
     def _fit_data(self, q, iq):
-        """Given a data set, extrapolate out to large q with Porod
-        and to q=0 with Guinier"""
+        """
+        Given a data set, extrapolate out to large q with Porod and
+        to q=0 with Guinier
+        """
         mask = np.logical_and(q > self.upperq[0], q < self.upperq[1])