Changeset d3e1870 in sasview

Timestamp:

Aug 19, 2016 7:34:50 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:

fdd3ba1

Parents:

bec6cb8

Message:

Update file converter docs to reflect NXcanSAS implementation

Location:

src/sas/sasgui/perspectives/file_converter

Files:

• converter_panel.py (modified) (1 diff)
• media/file_converter_help.rst (modified) (2 diffs)

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

@@ -499 +499 @@
         "files containing the Q-Axis and Intensity-Axis data, or a 2D BSL file"
         ", then chose where to save the converted file, and click Convert.\n"
-        "ASCII and OTOKO files will be converted to CanSAS XML, and OTKO files"
-        " to IGOR/DAT 2D Q_map files.\nCanSAS metadata can also be optionally "
-        "input below.")
+        "ASCII and OTOKO files can be converted to CanSAS XML, or NXcanSAS "
+        "HDF5 format. OTOKO files can only be converted to NXcanSAS.\nCanSAS "
+        "metadata can also be optionally input below.")
 
         instruction_label = wx.StaticText(self, -1, instructions,

src/sas/sasgui/perspectives/file_converter/media/file_converter_help.rst

@@ -8 +8 @@
 
 This tool converts file formats with the Q data and intensity data in separate
-files, into a single CanSAS XML file.
+files, into a single CanSAS XML or NXcanSAS HDF5 file.
 
-It can also convert 2D BSL files into IGOR/DAT 2D files, which are 3 column
-ASCII files of the format :code:`Qx - Qy - I(Qx,Qy)`.
+It can also convert 2D BSL files into NXcanSAS HDF5 files.
 
 The input files can be:
@@ -46 +45 @@
 and 1 as the increment.
 
-For OTOKO files, there is also the option to output the data as multiple frames
-in a single CanSAS file, or multiple files with one frame each. The single file
-option will produce one file with multiple `<SASdata>` elements. The multiple
-file option will output a file for each frame; each file will have one
-`<SASdata>` element, and the frame number will appended to the file name.
+CanSAS XML files can become quite large when exporting multiple frames to a
+single file, so there is an option in the *Select Frame* dialog to output each
+frame to it's own file. The single file option will produce one file with
+multiple `<SASdata>` elements. The multiple file option will output a file for
+each frame; each file will have one `<SASdata>` element, and the frame number
+will appended to the file name.
 
-All converted BSL frames will have the frame number appended to the file name.
+The multiple file option is not available when exporting to NXcanSAS. All
+frames will be written to the same file, since the HDF5 format is designed for
+handling large amounts of data.