Changeset 14e9eb3 in sasview for calculator/slit_length_calculator.py

Timestamp:

May 28, 2010 1:24:47 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:

25a2ee3

Parents:

2882fb5

Message:

working on documentation

File:

• calculator/slit_length_calculator.py (modified) (4 diffs)

calculator/slit_length_calculator.py

@@ -1 +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 2008, 2009, University of Tennessee
+This module is a small tool to allow user to quickly
+determine the slit length value of data.
 """
 from numpy import *
@@ -12 +7 @@
 class SlitlengthCalculator(object):
     """
-        compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I , and 3rd col. dI.: don't need the 3rd)
-        @object: data where are data.y and data.x
+    compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I ,
+    and 3rd col. dI.: don't need the 3rd)
     """
     def __init__(self):
@@ -31 +26 @@
     def set_data(self, x=None, y=None):
         """
-            set data
-            @ Param x, y: x array and y array
+        set data
+        :param x, y: x array and y array
         """
         self.x = x
         self.y = y
         
-        
     def calculate_slit_length(self):
         """
-            Calculate slit length using 10 max point
-            ToDo: Near future, it should be re-factored in better method.
+        Calculate slit length.
         """
         # None data do nothing
         if self.y == None or self.x == None:
             return
-        
         # set local variable
         y = self.y
@@ -96 +88 @@
         # set slit_length
         self.slit_length = slit_length
-   
-    def get_slit_length(self): 
-        """
-            Calculate and return the slit length
-        """
-        self.calculate_slit_length()
         return self.slit_length
-        
+  
     def get_slit_length_unit(self): 
         """
-            return the slit length unit
+        return the slit length unit.
         """
         return self.slit_length_unit