Changeset 896abb3 in sasview for pr_inversion/invertor.py

Timestamp:

May 23, 2008 2:31:50 PM (16 years ago)

Author:

Mathieu Doucet <doucetm@…>

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:

ffca8f2

Parents:

a1718df

Message:

Added docs

File:

• pr_inversion/invertor.py (modified) (4 diffs)

pr_inversion/invertor.py

@@ +1 @@
+"""
+    Module to perform P(r) inversion.
+    The module contains the Invertor class.
+"""
 from sans.pr.core.pr_inversion import Cinvertor
 import numpy
@@ -35 +39 @@
         
         Methods inherited from Cinvertor:
-        - get_peaks: returns the number of P(r) peaks
+        - 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
@@ -57 +64 @@
             Set the value of an attribute.
             Access the parent class methods for
-            x, y, err and d_max.
+            x, y, err, d_max, q_min, q_max and alpha
         """
         if   name=='x':
@@ -194 +201 @@
     
     def pr_err(self, c, c_cov, r):
-        #import math
-        #c_err = numpy.zeros(len(c))
-        #for i in range(len(c)):
-        #    try:
-        #        c_err[i] = math.sqrt(math.fabs(c_cov[i][i]))
-        #    except:
-        #        import sys
-        #        print sys.exc_value
-        #        print "oups", c_cov[i][i]
-        #        c_err[i] = c[i]
-
+        """    
+            Returns the value of P(r) for a given r, and base function
+            coefficients, with error.
+            
+            @param c: base function coefficients
+            @param c_cov: covariance matrice of the base function coefficients
+            @param r: r-value to evaluate P(r) at
+            @return: P(r)
+            
+        """
         return self.get_pr_err(c, c_cov, r)