| 1 | """ |
|---|
| 2 | This module provides a GUI for the file converter |
|---|
| 3 | """ |
|---|
| 4 | |
|---|
| 5 | import wx |
|---|
| 6 | import sys |
|---|
| 7 | import numpy as np |
|---|
| 8 | from wx.lib.scrolledpanel import ScrolledPanel |
|---|
| 9 | from sas.sasgui.guiframe.panel_base import PanelBase |
|---|
| 10 | from sas.sasgui.perspectives.calculator import calculator_widgets as widget |
|---|
| 11 | from sas.sasgui.perspectives.file_converter.converter_widgets import VectorInput |
|---|
| 12 | from sas.sasgui.perspectives.file_converter.meta_panels import MetadataWindow |
|---|
| 13 | from sas.sasgui.perspectives.file_converter.meta_panels import DetectorPanel |
|---|
| 14 | from sas.sasgui.perspectives.file_converter.meta_panels import SamplePanel |
|---|
| 15 | from sas.sasgui.perspectives.file_converter.meta_panels import SourcePanel |
|---|
| 16 | from sas.sasgui.guiframe.events import StatusEvent |
|---|
| 17 | from sas.sasgui.guiframe.documentation_window import DocumentationWindow |
|---|
| 18 | from sas.sasgui.guiframe.dataFitting import Data1D |
|---|
| 19 | from sas.sasgui.guiframe.utils import check_float |
|---|
| 20 | from sas.sascalc.dataloader.readers.cansas_reader import Reader as CansasReader |
|---|
| 21 | from sas.sasgui.perspectives.file_converter.bsl_loader import BSLLoader |
|---|
| 22 | from sas.sascalc.dataloader.data_info import Detector |
|---|
| 23 | from sas.sascalc.dataloader.data_info import Sample |
|---|
| 24 | from sas.sascalc.dataloader.data_info import Source |
|---|
| 25 | from sas.sascalc.dataloader.data_info import Vector |
|---|
| 26 | |
|---|
| 27 | # Panel size |
|---|
| 28 | if sys.platform.count("win32") > 0: |
|---|
| 29 | PANEL_TOP = 0 |
|---|
| 30 | _STATICBOX_WIDTH = 410 |
|---|
| 31 | _BOX_WIDTH = 200 |
|---|
| 32 | PANEL_SIZE = 480 |
|---|
| 33 | FONT_VARIANT = 0 |
|---|
| 34 | else: |
|---|
| 35 | PANEL_TOP = 60 |
|---|
| 36 | _STATICBOX_WIDTH = 430 |
|---|
| 37 | _BOX_WIDTH = 200 |
|---|
| 38 | PANEL_SIZE = 500 |
|---|
| 39 | FONT_VARIANT = 1 |
|---|
| 40 | |
|---|
| 41 | class ConverterPanel(ScrolledPanel, PanelBase): |
|---|
| 42 | |
|---|
| 43 | def __init__(self, parent, base=None, *args, **kwargs): |
|---|
| 44 | ScrolledPanel.__init__(self, parent, *args, **kwargs) |
|---|
| 45 | PanelBase.__init__(self) |
|---|
| 46 | self.SetupScrolling() |
|---|
| 47 | self.SetWindowVariant(variant=FONT_VARIANT) |
|---|
| 48 | |
|---|
| 49 | self.base = base |
|---|
| 50 | self.parent = parent |
|---|
| 51 | self.meta_frames = [] |
|---|
| 52 | |
|---|
| 53 | self.q_input = None |
|---|
| 54 | self.iq_input = None |
|---|
| 55 | self.output = None |
|---|
| 56 | self.data_type = "ascii" |
|---|
| 57 | |
|---|
| 58 | self.metadata = { |
|---|
| 59 | 'title': None, |
|---|
| 60 | 'run': None, |
|---|
| 61 | 'run_name': None, |
|---|
| 62 | 'instrument': None, |
|---|
| 63 | 'detector': [Detector()], |
|---|
| 64 | 'sample': Sample(), |
|---|
| 65 | 'source': Source() |
|---|
| 66 | } |
|---|
| 67 | |
|---|
| 68 | self.metadata['detector'][0].name = '' |
|---|
| 69 | self.metadata['source'].radiation = 'neutron' |
|---|
| 70 | |
|---|
| 71 | self._do_layout() |
|---|
| 72 | self.SetAutoLayout(True) |
|---|
| 73 | self.Layout() |
|---|
| 74 | |
|---|
| 75 | def convert_to_cansas(self, data, filename): |
|---|
| 76 | reader = CansasReader() |
|---|
| 77 | reader.write(filename, data) |
|---|
| 78 | |
|---|
| 79 | def extract_data(self, filename): |
|---|
| 80 | data = np.loadtxt(filename, dtype=str) |
|---|
| 81 | |
|---|
| 82 | if len(data.shape) != 1: |
|---|
| 83 | msg = "Error reading {}: Only one column of data is allowed" |
|---|
| 84 | raise Exception(msg.format(filename.split('\\')[-1])) |
|---|
| 85 | |
|---|
| 86 | is_float = True |
|---|
| 87 | try: |
|---|
| 88 | float(data[0]) |
|---|
| 89 | except: |
|---|
| 90 | is_float = False |
|---|
| 91 | |
|---|
| 92 | if not is_float: |
|---|
| 93 | end_char = data[0][-1] |
|---|
| 94 | # If lines end with comma or semi-colon, trim the last character |
|---|
| 95 | if end_char == ',' or end_char == ';': |
|---|
| 96 | data = map(lambda s: s[0:-1], data) |
|---|
| 97 | else: |
|---|
| 98 | msg = ("Error reading {}: Lines must end with a digit, comma " |
|---|
| 99 | "or semi-colon").format(filename.split('\\')[-1]) |
|---|
| 100 | raise Exception(msg) |
|---|
| 101 | |
|---|
| 102 | return np.array(data, dtype=np.float32) |
|---|
| 103 | |
|---|
| 104 | def on_convert(self, event): |
|---|
| 105 | if not self.validate_inputs(): |
|---|
| 106 | return |
|---|
| 107 | |
|---|
| 108 | try: |
|---|
| 109 | if self.data_type == 'ascii': |
|---|
| 110 | qdata = self.extract_data(self.q_input.GetPath()) |
|---|
| 111 | iqdata = self.extract_data(self.iq_input.GetPath()) |
|---|
| 112 | else: # self.data_type == 'bsl' |
|---|
| 113 | loader = BSLLoader(self.q_input.GetPath(), |
|---|
| 114 | self.iq_input.GetPath()) |
|---|
| 115 | bsl_data = loader.load_bsl_data() |
|---|
| 116 | qdata = bsl_data.q_axis.data[0] |
|---|
| 117 | iqdata = bsl_data.data_axis.data[0] |
|---|
| 118 | except Exception as ex: |
|---|
| 119 | msg = str(ex) |
|---|
| 120 | wx.PostEvent(self.parent.manager.parent, |
|---|
| 121 | StatusEvent(status=msg, info='error')) |
|---|
| 122 | return |
|---|
| 123 | |
|---|
| 124 | output_path = self.output.GetPath() |
|---|
| 125 | data = Data1D(x=qdata, y=iqdata) |
|---|
| 126 | data.filename = output_path.split('\\')[-1] |
|---|
| 127 | |
|---|
| 128 | if self.metadata['run'] is not None: |
|---|
| 129 | run = self.metadata['run'] |
|---|
| 130 | run_name = self.metadata['run_name'] |
|---|
| 131 | |
|---|
| 132 | if not isinstance(run, list) and run is not None: |
|---|
| 133 | self.metadata['run'] = [run] |
|---|
| 134 | else: |
|---|
| 135 | run = run[0] |
|---|
| 136 | |
|---|
| 137 | if not isinstance(run_name, dict): |
|---|
| 138 | if run_name is not None: |
|---|
| 139 | self.metadata['run_name'] = { run: run_name } |
|---|
| 140 | else: |
|---|
| 141 | self.metadata['run_name'] = {} |
|---|
| 142 | elif run_name != {}: |
|---|
| 143 | self.metadata['run_name'][run] = run_name.values()[0] |
|---|
| 144 | else: |
|---|
| 145 | self.metadata['run'] = [] |
|---|
| 146 | self.metadata['run_name'] = {} |
|---|
| 147 | |
|---|
| 148 | for attr, value in self.metadata.iteritems(): |
|---|
| 149 | if value is not None: |
|---|
| 150 | setattr(data, attr, value) |
|---|
| 151 | |
|---|
| 152 | self.convert_to_cansas(data, output_path) |
|---|
| 153 | wx.PostEvent(self.parent.manager.parent, |
|---|
| 154 | StatusEvent(status="Conversion completed.")) |
|---|
| 155 | |
|---|
| 156 | def on_help(self, event): |
|---|
| 157 | tree_location = ("user/sasgui/perspectives/file_converter/" |
|---|
| 158 | "file_converter_help.html") |
|---|
| 159 | doc_viewer = DocumentationWindow(self, -1, tree_location, |
|---|
| 160 | "", "File Converter Help") |
|---|
| 161 | |
|---|
| 162 | def validate_inputs(self): |
|---|
| 163 | msg = "You must select a" |
|---|
| 164 | if self.q_input.GetPath() == '': |
|---|
| 165 | msg += " Q Axis input file." |
|---|
| 166 | elif self.iq_input.GetPath() == '': |
|---|
| 167 | msg += "n Intensity input file." |
|---|
| 168 | elif self.output.GetPath() == '': |
|---|
| 169 | msg += "destination for the converted file." |
|---|
| 170 | if msg != "You must select a": |
|---|
| 171 | wx.PostEvent(self.parent.manager.parent, |
|---|
| 172 | StatusEvent(status=msg, info='error')) |
|---|
| 173 | return |
|---|
| 174 | |
|---|
| 175 | return True |
|---|
| 176 | |
|---|
| 177 | def show_detector_window(self, event): |
|---|
| 178 | if self.meta_frames != []: |
|---|
| 179 | for frame in self.meta_frames: |
|---|
| 180 | frame.panel.on_close() |
|---|
| 181 | detector_frame = MetadataWindow(DetectorPanel, |
|---|
| 182 | parent=self.parent.manager.parent, manager=self, |
|---|
| 183 | metadata=self.metadata['detector'][0], title='Detector Metadata') |
|---|
| 184 | self.meta_frames.append(detector_frame) |
|---|
| 185 | self.parent.manager.put_icon(detector_frame) |
|---|
| 186 | detector_frame.Show(True) |
|---|
| 187 | |
|---|
| 188 | def show_sample_window(self, event): |
|---|
| 189 | if self.meta_frames != []: |
|---|
| 190 | for frame in self.meta_frames: |
|---|
| 191 | frame.panel.on_close() |
|---|
| 192 | sample_frame = MetadataWindow(SamplePanel, |
|---|
| 193 | parent=self.parent.manager.parent, manager=self, |
|---|
| 194 | metadata=self.metadata['sample'], title='Sample Metadata') |
|---|
| 195 | self.meta_frames.append(sample_frame) |
|---|
| 196 | self.parent.manager.put_icon(sample_frame) |
|---|
| 197 | sample_frame.Show(True) |
|---|
| 198 | |
|---|
| 199 | def show_source_window(self, event): |
|---|
| 200 | if self.meta_frames != []: |
|---|
| 201 | for frame in self.meta_frames: |
|---|
| 202 | frame.panel.on_close() |
|---|
| 203 | source_frame = MetadataWindow(SourcePanel, |
|---|
| 204 | parent=self.parent.manager.parent, manager=self, |
|---|
| 205 | metadata=self.metadata['source'], title="Source Metadata") |
|---|
| 206 | self.meta_frames.append(source_frame) |
|---|
| 207 | self.parent.manager.put_icon(source_frame) |
|---|
| 208 | source_frame.Show(True) |
|---|
| 209 | |
|---|
| 210 | def on_collapsible_pane(self, event): |
|---|
| 211 | self.Freeze() |
|---|
| 212 | self.SetupScrolling() |
|---|
| 213 | self.parent.Layout() |
|---|
| 214 | self.Thaw() |
|---|
| 215 | |
|---|
| 216 | def datatype_changed(self, event): |
|---|
| 217 | event.Skip() |
|---|
| 218 | dtype = event.GetEventObject().GetName() |
|---|
| 219 | self.data_type = dtype |
|---|
| 220 | |
|---|
| 221 | def radiationtype_changed(self, event): |
|---|
| 222 | event.Skip() |
|---|
| 223 | rtype = event.GetEventObject().GetValue().lower() |
|---|
| 224 | self.metadata['source'].radiation = rtype |
|---|
| 225 | |
|---|
| 226 | def metadata_changed(self, event): |
|---|
| 227 | event.Skip() |
|---|
| 228 | textbox = event.GetEventObject() |
|---|
| 229 | attr = textbox.GetName() |
|---|
| 230 | value = textbox.GetValue().strip() |
|---|
| 231 | |
|---|
| 232 | if value == '': |
|---|
| 233 | self.metadata[attr] = None |
|---|
| 234 | else: |
|---|
| 235 | self.metadata[attr] = value |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | def _do_layout(self): |
|---|
| 239 | vbox = wx.BoxSizer(wx.VERTICAL) |
|---|
| 240 | |
|---|
| 241 | instructions = ("Select either single column ASCII files or BSL/OTOKO" |
|---|
| 242 | " files containing the Q-Axis and Intensity-axis data, chose where" |
|---|
| 243 | " to save the converted file, then click Convert to convert them " |
|---|
| 244 | "to CanSAS XML format. If required, metadata can also be input " |
|---|
| 245 | "below.") |
|---|
| 246 | instruction_label = wx.StaticText(self, -1, instructions, |
|---|
| 247 | size=(_STATICBOX_WIDTH+40, -1)) |
|---|
| 248 | instruction_label.Wrap(_STATICBOX_WIDTH+40) |
|---|
| 249 | vbox.Add(instruction_label, flag=wx.TOP | wx.LEFT | wx.RIGHT, border=5) |
|---|
| 250 | |
|---|
| 251 | section = wx.StaticBox(self, -1) |
|---|
| 252 | section_sizer = wx.StaticBoxSizer(section, wx.VERTICAL) |
|---|
| 253 | section_sizer.SetMinSize((_STATICBOX_WIDTH, -1)) |
|---|
| 254 | |
|---|
| 255 | input_grid = wx.GridBagSizer(5, 5) |
|---|
| 256 | |
|---|
| 257 | y = 0 |
|---|
| 258 | |
|---|
| 259 | q_label = wx.StaticText(self, -1, "Q-Axis Data: ") |
|---|
| 260 | input_grid.Add(q_label, (y,0), (1,1), wx.ALIGN_CENTER_VERTICAL, 5) |
|---|
| 261 | |
|---|
| 262 | self.q_input = wx.FilePickerCtrl(self, -1, |
|---|
| 263 | size=(_STATICBOX_WIDTH-80, -1), |
|---|
| 264 | message="Chose the Q-Axis data file.") |
|---|
| 265 | input_grid.Add(self.q_input, (y,1), (1,1), wx.ALL, 5) |
|---|
| 266 | y += 1 |
|---|
| 267 | |
|---|
| 268 | iq_label = wx.StaticText(self, -1, "Intensity-Axis Data: ") |
|---|
| 269 | input_grid.Add(iq_label, (y,0), (1,1), wx.ALIGN_CENTER_VERTICAL, 5) |
|---|
| 270 | |
|---|
| 271 | self.iq_input = wx.FilePickerCtrl(self, -1, |
|---|
| 272 | size=(_STATICBOX_WIDTH-80, -1), |
|---|
| 273 | message="Chose the Intensity-Axis data file.") |
|---|
| 274 | input_grid.Add(self.iq_input, (y,1), (1,1), wx.ALL, 5) |
|---|
| 275 | y += 1 |
|---|
| 276 | |
|---|
| 277 | data_type_label = wx.StaticText(self, -1, "Input Format: ") |
|---|
| 278 | input_grid.Add(data_type_label, (y,0), (1,1), |
|---|
| 279 | wx.ALIGN_CENTER_VERTICAL, 5) |
|---|
| 280 | radio_sizer = wx.BoxSizer(wx.HORIZONTAL) |
|---|
| 281 | ascii_btn = wx.RadioButton(self, -1, "ASCII", name="ascii", |
|---|
| 282 | style=wx.RB_GROUP) |
|---|
| 283 | ascii_btn.Bind(wx.EVT_RADIOBUTTON, self.datatype_changed) |
|---|
| 284 | radio_sizer.Add(ascii_btn) |
|---|
| 285 | bsl_btn = wx.RadioButton(self, -1, "BSL/OTOKO", name="bsl") |
|---|
| 286 | bsl_btn.Bind(wx.EVT_RADIOBUTTON, self.datatype_changed) |
|---|
| 287 | radio_sizer.Add(bsl_btn) |
|---|
| 288 | input_grid.Add(radio_sizer, (y,1), (1,1), wx.ALL, 5) |
|---|
| 289 | y += 1 |
|---|
| 290 | |
|---|
| 291 | radiation_label = wx.StaticText(self, -1, "Radiation Type: ") |
|---|
| 292 | input_grid.Add(radiation_label, (y,0), (1,1), wx.ALL, 5) |
|---|
| 293 | radiation_input = wx.ComboBox(self, -1, |
|---|
| 294 | choices=["Neutron", "X-Ray", "Muon", "Electron"], |
|---|
| 295 | name="radiation", style=wx.CB_READONLY, value="Neutron") |
|---|
| 296 | radiation_input.Bind(wx.EVT_COMBOBOX, self.radiationtype_changed) |
|---|
| 297 | input_grid.Add(radiation_input, (y,1), (1,1)) |
|---|
| 298 | y += 1 |
|---|
| 299 | |
|---|
| 300 | output_label = wx.StaticText(self, -1, "Output File: ") |
|---|
| 301 | input_grid.Add(output_label, (y,0), (1,1), wx.ALIGN_CENTER_VERTICAL, 5) |
|---|
| 302 | |
|---|
| 303 | self.output = wx.FilePickerCtrl(self, -1, |
|---|
| 304 | size=(_STATICBOX_WIDTH-80, -1), |
|---|
| 305 | message="Chose where to save the output file.", |
|---|
| 306 | style=wx.FLP_SAVE | wx.FLP_OVERWRITE_PROMPT | wx.FLP_USE_TEXTCTRL, |
|---|
| 307 | wildcard="*.xml") |
|---|
| 308 | input_grid.Add(self.output, (y,1), (1,1), wx.ALL, 5) |
|---|
| 309 | y += 1 |
|---|
| 310 | |
|---|
| 311 | convert_btn = wx.Button(self, wx.ID_OK, "Convert") |
|---|
| 312 | input_grid.Add(convert_btn, (y,0), (1,1), wx.ALL, 5) |
|---|
| 313 | convert_btn.Bind(wx.EVT_BUTTON, self.on_convert) |
|---|
| 314 | |
|---|
| 315 | help_btn = wx.Button(self, -1, "HELP") |
|---|
| 316 | input_grid.Add(help_btn, (y,1), (1,1), wx.ALL, 5) |
|---|
| 317 | help_btn.Bind(wx.EVT_BUTTON, self.on_help) |
|---|
| 318 | |
|---|
| 319 | section_sizer.Add(input_grid) |
|---|
| 320 | |
|---|
| 321 | vbox.Add(section_sizer, flag=wx.ALL, border=5) |
|---|
| 322 | |
|---|
| 323 | metadata_section = wx.CollapsiblePane(self, -1, "Metadata", |
|---|
| 324 | size=(_STATICBOX_WIDTH+40, -1), style=wx.WS_EX_VALIDATE_RECURSIVELY) |
|---|
| 325 | metadata_pane = metadata_section.GetPane() |
|---|
| 326 | metadata_grid = wx.GridBagSizer(5, 5) |
|---|
| 327 | |
|---|
| 328 | metadata_section.Bind(wx.EVT_COLLAPSIBLEPANE_CHANGED, |
|---|
| 329 | self.on_collapsible_pane) |
|---|
| 330 | |
|---|
| 331 | y = 0 |
|---|
| 332 | windows = ['detector', 'sample', 'source'] |
|---|
| 333 | for item in self.metadata.keys(): |
|---|
| 334 | # Don't make fields for properties that have their own windows |
|---|
| 335 | if item in windows: continue |
|---|
| 336 | label_txt = item.replace('_', ' ').capitalize() |
|---|
| 337 | label = wx.StaticText(metadata_pane, -1, label_txt, |
|---|
| 338 | style=wx.ALIGN_CENTER_VERTICAL) |
|---|
| 339 | input_box = wx.TextCtrl(metadata_pane, name=item, |
|---|
| 340 | size=(_STATICBOX_WIDTH-80, -1)) |
|---|
| 341 | input_box.Bind(wx.EVT_TEXT, self.metadata_changed) |
|---|
| 342 | metadata_grid.Add(label, (y,0), (1,1), |
|---|
| 343 | wx.ALL | wx.ALIGN_CENTER_VERTICAL, 5) |
|---|
| 344 | metadata_grid.Add(input_box, (y,1), (1,2), wx.EXPAND) |
|---|
| 345 | y += 1 |
|---|
| 346 | |
|---|
| 347 | detector_label = wx.StaticText(metadata_pane, -1, |
|---|
| 348 | "Detector:") |
|---|
| 349 | metadata_grid.Add(detector_label, (y, 0), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 350 | detector_btn = wx.Button(metadata_pane, -1, "Enter Detector Metadata") |
|---|
| 351 | metadata_grid.Add(detector_btn, (y, 1), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 352 | detector_btn.Bind(wx.EVT_BUTTON, self.show_detector_window) |
|---|
| 353 | y += 1 |
|---|
| 354 | |
|---|
| 355 | sample_label = wx.StaticText(metadata_pane, -1, "Sample: ") |
|---|
| 356 | metadata_grid.Add(sample_label, (y,0), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 357 | sample_btn = wx.Button(metadata_pane, -1, "Enter Sample Metadata") |
|---|
| 358 | metadata_grid.Add(sample_btn, (y,1), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 359 | sample_btn.Bind(wx.EVT_BUTTON, self.show_sample_window) |
|---|
| 360 | y += 1 |
|---|
| 361 | |
|---|
| 362 | source_label = wx.StaticText(metadata_pane, -1, "Source: ") |
|---|
| 363 | metadata_grid.Add(source_label, (y,0), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 364 | source_btn = wx.Button(metadata_pane, -1, "Enter Source Metadata") |
|---|
| 365 | source_btn.Bind(wx.EVT_BUTTON, self.show_source_window) |
|---|
| 366 | metadata_grid.Add(source_btn, (y,1), (1,1), wx.ALL | wx.EXPAND, 5) |
|---|
| 367 | y += 1 |
|---|
| 368 | |
|---|
| 369 | metadata_pane.SetSizer(metadata_grid) |
|---|
| 370 | |
|---|
| 371 | vbox.Add(metadata_section, proportion=0, flag=wx.ALL, border=5) |
|---|
| 372 | |
|---|
| 373 | vbox.Fit(self) |
|---|
| 374 | self.SetSizer(vbox) |
|---|
| 375 | |
|---|
| 376 | class ConverterWindow(widget.CHILD_FRAME): |
|---|
| 377 | |
|---|
| 378 | def __init__(self, parent=None, title='File Converter', base=None, |
|---|
| 379 | manager=None, size=(PANEL_SIZE * 1.05, PANEL_SIZE / 1.25), |
|---|
| 380 | *args, **kwargs): |
|---|
| 381 | kwargs['title'] = title |
|---|
| 382 | kwargs['size'] = size |
|---|
| 383 | widget.CHILD_FRAME.__init__(self, parent, *args, **kwargs) |
|---|
| 384 | |
|---|
| 385 | self.manager = manager |
|---|
| 386 | self.panel = ConverterPanel(self, base=None) |
|---|
| 387 | self.Bind(wx.EVT_CLOSE, self.on_close) |
|---|
| 388 | self.SetPosition((wx.LEFT, PANEL_TOP)) |
|---|
| 389 | self.Show(True) |
|---|
| 390 | |
|---|
| 391 | def on_close(self, event): |
|---|
| 392 | if self.manager is not None: |
|---|
| 393 | self.manager.converter_frame = None |
|---|
| 394 | self.Destroy() |
|---|
