Changeset ba65aff in sasview for src/sas/sasgui/perspectives/file_converter/otoko_loader.py

Timestamp:

Aug 8, 2016 10:09:38 AM (8 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.1.1, release-4.1.2, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

9e9f848

Parents:

d6bf064

Message:

Add docstrings & comments, and rename old bsl_loader to otoko_loader

File:

• src/sas/sasgui/perspectives/file_converter/otoko_loader.py (moved) (moved from src/sas/sasgui/perspectives/file_converter/bsl_loader.py) (8 diffs)

src/sas/sasgui/perspectives/file_converter/otoko_loader.py

@@ -15 +15 @@
         self.__dict__.update(kwds)
 
-class BSLParsingError(Exception):
+class OTOKOParsingError(Exception):
     pass
 
-class BSLData:
+class OTOKOData:
     def __init__(self, q_axis, data_axis):
         self.q_axis = q_axis
         self.data_axis = data_axis
 
-class BSLLoader(object):
+class OTOKOLoader(object):
 
     def __init__(self, qaxis_path, data_path):
@@ -36 +36 @@
 
         Given the paths of two header files, this function will load each axis in
-        turn.  If loading is successfull then an instance of the BSLData class
+        turn.  If loading is successfull then an instance of the OTOKOData class
         will be returned, else an exception will be raised.
 
@@ -50 +50 @@
         data_axis = self._load_bsl_axis(self.data_path)
 
-        return BSLData(q_axis, data_axis)
+        return OTOKOData(q_axis, data_axis)
 
     def _load_bsl_axis(self, header_path):
@@ -60 +60 @@
         """
         if not os.path.exists(header_path):
-            raise BSLParsingError("The header file %s does not exist." % header_path)
+            raise OTOKOParsingError("The header file %s does not exist." % header_path)
 
         binary_file_info_list = []
@@ -69 +69 @@
             lines = header_file.readlines()
             if len(lines) < 4:
-                raise BSLParsingError("Expected more lines in %s." % header_path)
+                raise OTOKOParsingError("Expected more lines in %s." % header_path)
 
             info = lines[0] + lines[1]
@@ -85 +85 @@
 
                 if len(indicators) != 10:
-                    raise BSLParsingError(
+                    raise OTOKOParsingError(
                         "Expected 10 integer indicators on line 3 of %s." \
                         % header_path)
                 if not all([i.isdigit() for i in indicators]):
-                    raise BSLParsingError(
+                    raise OTOKOParsingError(
                         "Expected all indicators on line 3 of %s to be integers." \
                         % header_path)
@@ -115 +115 @@
         all_n_channels = [info.n_channels for info in binary_file_info_list]
         if not all(all_n_channels[0] == c for c in all_n_channels):
-            raise BSLParsingError(
+            raise OTOKOParsingError(
                 "Expected all binary files listed in %s to have the same number of channels." % header_path)
 
@@ -123 +123 @@
         for info in binary_file_info_list:
             if not os.path.exists(info.file_path):
-                raise BSLParsingError(
+                raise OTOKOParsingError(
                     "The data file %s does not exist." % info.file_path)