Changeset 51f14603 in sasview for src/sans/pr/invertor.py

Timestamp:

Apr 3, 2014 11:37:53 AM (11 years ago)

Author:

Peter Parker

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, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

2f2d9d0

Parents:

eea3ffa

Message:

Refs #202 - Fix Sphinx build errors (not including park-1.2.1/). Most warnings remain.

File:

• src/sans/pr/invertor.py (modified) (7 diffs)

src/sans/pr/invertor.py

@@ -61 +61 @@
     
     In the following i refers to the ith base function coefficient.
-    The matrix has its entries j in its first Npts rows set to
+    The matrix has its entries j in its first Npts rows set to ::
+
         A[j][i] = (Fourier transformed base function for point j)
         
     We them choose a number of r-points, n_r, to evaluate the second
     derivative of P(r) at. This is used as our regularization term.
-    For a vector r of length n_r, the following n_r rows are set to
+    For a vector r of length n_r, the following n_r rows are set to ::
+
         A[j+Npts][i] = (2nd derivative of P(r), d**2(P(r))/d(r)**2,
         evaluated at r[j])
         
-    The vector b has its first Npts entries set to
+    The vector b has its first Npts entries set to ::
+
         b[j] = (I(q) observed for point j)
         
@@ -79 +82 @@
     
     Methods inherited from Cinvertor:
-    - get_peaks(pars): returns the number of P(r) peaks
-    - oscillations(pars): returns the oscillation parameters for the output P(r)
-    - get_positive(pars): returns the fraction of P(r) that is above zero
-    - get_pos_err(pars): returns the fraction of P(r) that is 1-sigma above zero
+
+    * ``get_peaks(pars)``: returns the number of P(r) peaks
+    * ``oscillations(pars)``: returns the oscillation parameters for the output P(r)
+    * ``get_positive(pars)``: returns the fraction of P(r) that is above zero
+    * ``get_pos_err(pars)``: returns the fraction of P(r) that is 1-sigma above zero
     """
     ## Chisqr of the last computation
@@ -252 +256 @@
         
         In the following i refers to the ith base function coefficient.
-        The matrix has its entries j in its first Npts rows set to
+        The matrix has its entries j in its first Npts rows set to ::
+
             A[i][j] = (Fourier transformed base function for point j)
             
         We them choose a number of r-points, n_r, to evaluate the second
         derivative of P(r) at. This is used as our regularization term.
-        For a vector r of length n_r, the following n_r rows are set to
+        For a vector r of length n_r, the following n_r rows are set to ::
+
             A[i+Npts][j] = (2nd derivative of P(r), d**2(P(r))/d(r)**2, evaluated at r[j])
             
-        The vector b has its first Npts entries set to
+        The vector b has its first Npts entries set to ::
+
             b[j] = (I(q) observed for point j)
             
@@ -271 +278 @@
         :param nr: number of r points to evaluate the 2nd derivative at for the reg. term.
         :return: c_out, c_cov - the coefficients with covariance matrix
-        
         """
         # Reset the background value before proceeding
@@ -395 +401 @@
         
         In the following i refers to the ith base function coefficient.
-        The matrix has its entries j in its first Npts rows set to
+        The matrix has its entries j in its first Npts rows set to ::
+
             A[i][j] = (Fourier transformed base function for point j)
             
         We them choose a number of r-points, n_r, to evaluate the second
         derivative of P(r) at. This is used as our regularization term.
-        For a vector r of length n_r, the following n_r rows are set to
+        For a vector r of length n_r, the following n_r rows are set to ::
+
             A[i+Npts][j] = (2nd derivative of P(r), d**2(P(r))/d(r)**2,
             evaluated at r[j])
             
-        The vector b has its first Npts entries set to
+        The vector b has its first Npts entries set to ::
+
             b[j] = (I(q) observed for point j)
             
@@ -413 +422 @@
         
         :param nfunc: number of base functions to use.
-        :param nr: number of r points to evaluate the 2nd derivative at
-            for the reg. term.
+        :param nr: number of r points to evaluate the 2nd derivative at for the reg. term.
 
         If the result does not allow us to compute the covariance matrix,
@@ -512 +520 @@
         number of terms
         
-        :param isquit_func: reference to thread function to call to
-                            check whether the computation needs to
-                            be stopped.
+        :param isquit_func:
+          reference to thread function to call to check whether the computation needs to
+          be stopped.
         
         :return: number of terms, alpha, message