Changeset d84a90c in sasview for pr_inversion/distance_explorer.py

Timestamp:

Jun 3, 2010 4:47:46 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

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:

7116b6e0

Parents:

aa36f96

Message:

working on documentation

File:

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

pr_inversion/distance_explorer.py

@@ +1 @@
+
+################################################################################
+#This software was developed by the University of Tennessee as part of the
+#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
+#project funded by the US National Science Foundation. 
+#
+#See the license text in license.txt
+#
+#copyright 2009, University of Tennessee
+################################################################################
+
 """
-    Module to explore the P(r) inversion results for a range
-    of D_max value. User picks a number of points and a range of
-    distances, then get a series of outputs as a function of D_max
-    over that range.
-    
-    This software was developed by the University of Tennessee as part of the
-    Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
-    project funded by the US National Science Foundation. 
+Module to explore the P(r) inversion results for a range
+of D_max value. User picks a number of points and a range of
+distances, then get a series of outputs as a function of D_max
+over that range.
+"""
 
-    See the license text in license.txt
-
-    copyright 2009, University of Tennessee
-"""
 import numpy
 import math
@@ -19 +23 @@
 class Results:
     """
-        Class to hold the inversion output parameters
-        as a function of D_max
+    Class to hold the inversion output parameters
+    as a function of D_max
     """
     def __init__(self):
         """
-            Initialization. Create empty arrays
-            and dictionary of labels.
+        Initialization. Create empty arrays
+        and dictionary of labels.
         """
         # Array of output for each inversion
@@ -41 +45 @@
 class DistExplorer(object):
     """
-        The explorer class
+    The explorer class
     """
     
     def __init__(self, pr_state):
         """
-            Initialization.
-            
-            @param pr_state: sans.pr.invertor.Invertor object
+        Initialization.
+        
+        :param pr_state: sans.pr.invertor.Invertor object
+        
         """
         self.pr_state  = pr_state
@@ -57 +62 @@
     def __call__(self, dmin=None, dmax=None, npts=10):
         """
-            Compute the outputs as a function of D_max.
-            
-            @param dmin: minimum value for D_max
-            @param dmax: maximum value for D_max
-            @param npts: number of points for D_max
+        Compute the outputs as a function of D_max.
+        
+        :param dmin: minimum value for D_max
+        :param dmax: maximum value for D_max
+        :param npts: number of points for D_max
+        
         """
         # Take care of the defaults if needed