Changeset 58a255b in sasview for src/sas

Timestamp:

Jul 20, 2017 11:38:31 AM (7 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.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

0f010c9

Parents:

f25328a5

Message:

Better comments & add docstrings

File:

• src/sas/sascalc/file_converter/ascii2d_loader.py (modified) (5 diffs)

src/sas/sascalc/file_converter/ascii2d_loader.py

@@ -7 +7 @@
 
 # ISIS 2D ASCII File Format
+# http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf
 # line: property
 # 0: File header
@@ -23 +24 @@
 
     def __init__(self, data_path):
+        """
+        :param data_path: The path to the file to load
+        """
         self.data_path = data_path
 
     def load(self):
+        """
+        Load the data from the file into a Data2D object
+
+        :return: A Data2D instance containing data from the file
+        :raises ValueError: Raises a ValueError if the file is incorrectly formatted
+        """
         file_handle = open(self.data_path, 'r')
         file_buffer = file_handle.read()
         all_lines = file_buffer.splitlines()
 
-        def _load_qs(lines, start_line, num_points):
+        # Load num_points line-by-line from lines into a numpy array, starting
+        # on line number start_line
+        def _load_points(lines, start_line, num_points):
             qs = np.zeros(num_points)
             n = start_line
@@ -41 +53 @@
             return n, qs
 
-        # Skip nUseRec lines
         current_line = 4
         try:
+            # Skip nUseRec lines
             nUseRec = int(all_lines[current_line].strip()[0])
             current_line += nUseRec + 1
@@ -49 +61 @@
             num_qs = int(all_lines[current_line].strip())
             current_line += 1
-            current_line, qx = _load_qs(all_lines, current_line, num_qs)
+            current_line, qx = _load_points(all_lines, current_line, num_qs)
 
             # Read qy data
             num_qs = int(all_lines[current_line].strip())
             current_line += 1
-            current_line, qy = _load_qs(all_lines, current_line, num_qs)
+            current_line, qy = _load_points(all_lines, current_line, num_qs)
         except ValueError as e:
             err_msg = "File incorrectly formatted.\n"
@@ -105 +117 @@
         current_line += 1
 
-        current_line, I = _load_qs(all_lines, current_line, width*height)
+        current_line, I = _load_points(all_lines, current_line, width*height)
         dI = np.zeros(width*height)
 
+        # Load error data if it's provided
         if iflag == 3:
-            _, dI = _load_qs(all_lines, current_line, width*height)
+            _, dI = _load_points(all_lines, current_line, width*height)
 
         # Format data for use with Data2D