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

Timestamp:

Aug 8, 2016 12:09:38 PM (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/converter_panel.py (modified) (19 diffs)

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

@@ -23 +23 @@
 from sas.sasgui.perspectives.file_converter.cansas_writer import CansasWriter
 from sas.sascalc.dataloader.readers.red2d_reader import Reader as Red2DWriter
-from sas.sasgui.perspectives.file_converter.bsl_loader import BSLLoader as OTOKOLoader
+from sas.sasgui.perspectives.file_converter.otoko_loader import OTOKOLoader
 from sas.sascalc.file_converter.bsl_loader import BSLLoader
 from sas.sascalc.dataloader.data_info import Detector
@@ -45 +45 @@
 
 class ConverterPanel(ScrolledPanel, PanelBase):
+    """
+    This class provides the File Converter GUI
+    """
 
     def __init__(self, parent, base=None, *args, **kwargs):
@@ -56 +59 @@
         self.meta_frames = []
 
+        # GUI inputs
         self.q_input = None
         self.iq_input = None
@@ -61 +65 @@
         self.radiation_input = None
         self.metadata_section = None
+
         self.data_type = "ascii"
 
+        # Metadata values
         self.title = None
         self.run = None
@@ -80 +86 @@
 
     def convert_to_cansas(self, frame_data, filename, single_file):
-        reader = CansasWriter()
+        """
+        Saves an array of Data1D objects to a single CanSAS file with multiple
+        <SasData> elements, or to multiple CanSAS files, each with one
+        <SasData> element.
+
+        :param frame_data: The Data1D object to save
+        :param filename: Where to save the CanSAS file
+        :param single_file: If true, array is saved as a single file, if false,
+        each item in the array is saved to it's own file
+        """
+        writer = CansasWriter()
         entry_attrs = None
         if self.run_name is not None:
             entry_attrs = { 'name': self.run_name }
         if single_file:
-            reader.write(filename, frame_data,
+            writer.write(filename, frame_data,
                 sasentry_attrs=entry_attrs)
         else:
@@ -92 +108 @@
             name = filename.replace(ext, '')
             for i in range(len(frame_data)):
-                f_name = "{}{}{}".format(name, i+1, ext)
-                reader.write(f_name, [frame_data[i]],
+                # TODO: Change i to actual frame number, not consecutive numbers
+                # (maybe use info in params from frame select dialog, ie
+                # increment. Alternatively, change frame_data to a dictionary
+                # with the frame number as key and use frame_data.iteritems()
+                # (would need to update CansasWriter to deal with this)
+                f_name = name + str(i) + ext
+                writer.write(f_name, [frame_data[i]],
                     sasentry_attrs=entry_attrs)
 
     def extract_ascii_data(self, filename):
+        """
+        Extracts data from a single-column ASCII file
+
+        :param filename: The file to load data from
+        :return: A numpy array containing the extracted data
+        """
         data = np.loadtxt(filename, dtype=str)
 
@@ -122 +149 @@
 
     def extract_otoko_data(self, filename):
+        """
+        Extracts data from a 1D OTOKO file
+
+        :param filename: The OTOKO file to load the data from
+        :return: A numpy array containing the extracted data
+        """
         loader = OTOKOLoader(self.q_input.GetPath(),
             self.iq_input.GetPath())
@@ -139 +172 @@
 
     def ask_frame_range(self, n_frames):
+        """
+        Display a dialog asking the user to input the range of frames they
+        would like to export
+
+        :param n_frames: How many frames the loaded data file has
+        :return: A dictionary containing the parameters input by the user
+        """
         valid_input = False
         is_bsl = (self.data_type == 'bsl')
@@ -179 +219 @@
 
     def on_convert(self, event):
+        """Called when the Convert button is clicked"""
         if not self.validate_inputs():
             return
@@ -191 +232 @@
                 qdata, iqdata = self.extract_otoko_data(self.q_input.GetPath())
             else: # self.data_type == 'bsl'
+                # TODO: Refactor this into an extract_bsl_data method
                 loader = BSLLoader(self.iq_input.GetPath())
                 frames = [0]
@@ -243 +285 @@
         # Standard file has 3 frames: SAS, calibration and WAS
         if n_frames > 3:
-            # File has multiple frames
+            # File has multiple frames - ask the user which ones they want to
+            # export
             params = self.ask_frame_range(n_frames)
             frames = params['frames']
@@ -254 +297 @@
         output_path = self.output.GetPath()
 
+        # Prepare the metadata for writing to a file
         if self.run is None:
             self.run = []
@@ -293 +337 @@
 
     def on_help(self, event):
+        """
+        Show the File Converter documentation
+        """
         tree_location = ("user/sasgui/perspectives/file_converter/"
             "file_converter_help.html")
@@ -314 +361 @@
 
     def show_detector_window(self, event):
+        """
+        Show the window for inputting :class:`~sas.sascalc.dataloader.data_info.Detector~` metadata
+        """
         if self.meta_frames != []:
             for frame in self.meta_frames:
@@ -325 +375 @@
 
     def show_sample_window(self, event):
+        """
+        Show the window for inputting :class:`~sas.sascalc.dataloader.data_info.Sample~` metadata
+        """
         if self.meta_frames != []:
             for frame in self.meta_frames:
@@ -336 +389 @@
 
     def show_source_window(self, event):
+        """
+        Show the window for inputting :class:`~sas.sascalc.dataloader.data_info.Source~` metadata
+        """
         if self.meta_frames != []:
             for frame in self.meta_frames:
@@ -347 +403 @@
 
     def on_collapsible_pane(self, event):
+        """
+        Resize the scrollable area to fit the metadata pane when it's
+        collapsed or expanded
+        """
         self.Freeze()
         self.SetupScrolling()
@@ -353 +413 @@
 
     def datatype_changed(self, event):
+        """
+        Update the UI and self.data_type when a data type radio button is
+        pressed
+        """
         event.Skip()
         dtype = event.GetEventObject().GetName()
@@ -527 +591 @@
 
 class ConverterWindow(widget.CHILD_FRAME):
+    """Displays ConverterPanel"""
 
     def __init__(self, parent=None, title='File Converter', base=None,