Changeset 9c500ab in sasview for src/sas

Timestamp:

Aug 9, 2016 4:23:08 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:

dc8a553

Parents:

b7c21a7

Message:

Add more descriptive error messages

Location:

src/sas

Files:

• sascalc/file_converter/bsl_loader.py (modified) (4 diffs)
• sasgui/perspectives/file_converter/converter_panel.py (modified) (4 diffs)
• sasgui/perspectives/file_converter/otoko_loader.py (modified) (4 diffs)

src/sas/sascalc/file_converter/bsl_loader.py

@@ -4 +4 @@
 import numpy as np
 
+class BSLParsingError(Exception):
+    pass
+
 class BSLLoader(CLoader):
+    """
+    Loads 2D SAS data from a BSL file.
+    CLoader is a C extension (found in c_ext/bsl_loader.c)
 
-    # TODO: Change to __init__(self, filename, frame)
-    # and parse n_(pixels/rasters) from header file
+    See http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html
+    for more info on the BSL file format.
+    """
+
     def __init__(self, filename):
+        """
+        Parses the BSL header file and sets instance variables apropriately
+
+        :param filename: Path to the BSL header file
+        """
         header_file = open(filename, 'r')
         data_info = {}
@@ -15 +28 @@
 
         [folder, filename] = os.path.split(filename)
+        # SAS data will be in file Xnn001.mdd
+        sasdata_filename = filename.replace('000.', '001.')
+        if sasdata_filename == filename:
+            err_msg = ("Invalid header filename {}.\n Should be of the format "
+                "Xnn000.XXX where X is any alphanumeric character and n is any"
+                " digit.").format(filename)
+            raise BSLParsingError(err_msg)
 
         # First 2 lines are headers
@@ -29 +49 @@
                 err_msg = "Invalid header file: {}".format(filename)
                 break
-            # SAS data will be in file Xnn001.mdd
-            if data_filename != filename.replace('0.', '1.'):
+
+            if data_filename != sasdata_filename:
+                last_file = (metadata[9] == '0')
+                if last_file: # Reached last file we have metadata for
+                    is_valid = False
+                    err_msg = "No metadata for {} found in header file: {}"
+                    err_msg = err_msg.format(sasdata_filename, filename)
+                    break
                 continue
             try:
@@ -43 +69 @@
                 is_valid = False
                 err_msg = "Invalid metadata in header file for {}"
-                err_msg = err_msg.format(filename.replace('0.', '1.'))
+                err_msg = err_msg.format(sasdata_filename)
             break
 
         if not is_valid:
-            raise Exception(err_msg)
-
-        if data_info['frames'] == 1:
-            # File is actually in OTOKO (1D) format
-            # Number of frames is 2nd indicator,
-            data_info['frames'] = data_info['rasters']
-            data_info['rasters'] = data_info['pixels']
-            data_info['pixels'] = 1
+            raise BSLParsingError(err_msg)
 
         CLoader.__init__(self, data_info['filename'], data_info['frames'],

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

@@ -186 +186 @@
         loader = OTOKOLoader(self.q_input.GetPath(),
             self.iq_input.GetPath())
-        bsl_data = loader.load_bsl_data()
-        qdata = bsl_data.q_axis.data
-        iqdata = bsl_data.data_axis.data
+        otoko_data = loader.load_otoko_data()
+        qdata = otoko_data.q_axis.data
+        iqdata = otoko_data.data_axis.data
         if len(qdata) > 1:
             msg = ("Q-Axis file has multiple frames. Only 1 frame is "
@@ -212 +212 @@
         loader = BSLLoader(filename)
         frames = [0]
+        should_continue = True
+
         if loader.n_frames > 1:
             params = self.ask_frame_range(loader.n_frames)
             frames = params['frames']
+        elif loader.n_rasters == 1 and loader.n_frames == 1:
+            message = ("The selected file is an OTOKO file. Please select the "
+            "'OTOKO 1D' option if you wish to convert it.")
+            dlg = wx.MessageDialog(self,
+            message,
+            'Error!',
+            wx.OK | wx.ICON_WARNING)
+            dlg.ShowModal()
+            should_continue = False
+            dlg.Destroy()
+        else:
+            message = ("The selected data file only has 1 frame, it might be"
+                " a multi-frame OTOKO file.\nContinue conversion?")
+            dlg = wx.MessageDialog(self,
+            message,
+            'Warning!',
+            wx.YES_NO | wx.ICON_WARNING)
+            should_continue = (dlg.ShowModal() == wx.ID_YES)
+            dlg.Destroy()
+
+        if not should_continue:
+            return None, None, None
+
         frame_data = {}
 
@@ -294 +319 @@
                     self.iq_input.GetPath())
 
+                if x_data == None and y_data == None and frame_data == None:
+                    wx.PostEvent(self.parent.manager.parent,
+                        StatusEvent(status="Conversion cancelled."))
+                    return
+
                 file_path = self.output.GetPath()
                 self.convert_to_red2d(file_path, x_data, y_data, frame_data)
@@ -342 +372 @@
             'source': self.source
         }
-        import pdb; pdb.set_trace()
 
         frame_data = {}

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

@@ -1 +1 @@
 """
 Here we handle loading of "OTOKO" data (for more info about this format see
-the comment in load_bsl_data).  Given the paths of header and data files, we
+the comment in load_otoko_data).  Given the paths of header and data files, we
 aim to load the data into numpy arrays for use later.
 """
@@ -29 +29 @@
         self.data_path = data_path
 
-    def load_bsl_data(self):
+    def load_otoko_data(self):
         """
         Loads "OTOKO" data, which is a format that stores each axis separately.
@@ -42 +42 @@
         http://www.diamond.ac.uk/Home/Beamlines/small-angle/SAXS-Software/CCP13/
         XOTOKO.html
-
-        The BSL format, which is based on OTOKO, is also supported.  Find out more
-        about the BSL format at http://www.diamond.ac.uk/Home/Beamlines/small-angle
-        /SAXS-Software/CCP13/BSL.html.
         """
-        q_axis    = self._load_bsl_axis(self.qaxis_path)
-        data_axis = self._load_bsl_axis(self.data_path)
+        q_axis    = self._load_otoko_axis(self.qaxis_path)
+        data_axis = self._load_otoko_axis(self.data_path)
 
         return OTOKOData(q_axis, data_axis)
 
-    def _load_bsl_axis(self, header_path):
+    def _load_otoko_axis(self, header_path):
         """
         Loads an "OTOKO" axis, given the header file path.  Essentially, the
@@ -107 +103 @@
                     last_file  = int(indicators[9]) == 0 # We don't use this.
                 )
+                if binary_file_info.dimensions != 1:
+                    msg = "File {} has {} dimensions, expected 1. Is it a BSL file?"
+                    raise OTOKOParsingError(msg.format(filename.strip(),
+                        binary_file_info.dimensions))
+
                 binary_file_info_list.append(binary_file_info)