Changeset d73998c in sasview for src/sas/sasgui/perspectives/file_converter

Timestamp:

Oct 8, 2016 1:07:32 PM (8 years ago)

Author:

smk78

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:

e28f34d

Parents:

381bafd

Message:

Minor tweaks to the text. Closes #736

File:

• src/sas/sasgui/perspectives/file_converter/media/file_converter_help.rst (modified) (3 diffs)

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

@@ -9 +9 @@
 -----------
 
-This tool converts file formats with the Q data and intensity data in separate
-files, into a single CanSAS XML or NXcanSAS HDF5 file.
+This tool converts file formats with the Q data and Intensity data stored in separate
+files, into a single CanSAS (XML) or NXcanSAS (HDF5) file.
 
-It can also convert 2D BSL files into NXcanSAS HDF5 files.
+It can also convert 2D BSL/OTOKO files into a NXcanSAS file.
 
-Supported input file formats:
+Supported input file formats (examples may be found in the /test/convertible_files folder):
 
-*   Single column ASCII data, with lines that end with a digit (no delimiter),
-    comma or semi-colon.
-*   `One-Dimensional OTOKO formatted
+*   Single-column ASCII data, with lines that end without any delimiter,
+    or with a comma or semi-colon delimiter
+*   `1D BSL/OTOKO format
     <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
-    SAXS-Software/CCP13/XOTOKO.html>`_ data.
-*   `Two-Dimensional BSL formatted
+    SAXS-Software/CCP13/BSL.html>`_ data
+*   `2D BSL/OTOKO format
     <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
-    SAXS-Software/CCP13/BSL.html>`_ data.
+    SAXS-Software/CCP13/BSL.html>`_ data
 
-Supported output file formats@
+Supported output file formats:
 
-*   `CanSAS XML <http://www.cansas.org/formats/canSAS1d/1.1/doc/>`_
-*   `NXcanSAS HDF5 <http://download.nexusformat.org/sphinx/classes/contributed_definitions/NXcanSAS.html>`_
+*   `CanSAS <http://www.cansas.org/formats/canSAS1d/1.1/doc/>`_
+*   `NXcanSAS <http://download.nexusformat.org/sphinx/classes/contributed_definitions/NXcanSAS.html>`_
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -35 +35 @@
 --------------
 
-1) Select the files containing your Q-Axis and Intensity-Axis data
-2) Chose whether the files are in ASCII, OTOKO or BSL format
-3) Chose where you would like to save the converted file
+1) Select the files containing your Q-axis and Intensity-axis data
+2) Choose whether the files are in ASCII, 1D BSL/OTOKO or 2D BSL/OTOKO format
+3) Choose where you would like to save the converted file
 4) Optionally, input some metadata such as sample size, detector name, etc
-5) Click *Convert* to save the converted file to disk
+5) Click *Convert* to save the converted file
 
 Files With Multiple Frames
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If a BSL/OTOKO file with multiple frames is selected for the intensity-axis
+If a BSL/OTOKO file with multiple frames is selected for the Intensity-axis
 file, a dialog will appear asking which frames you would like converted. You
 may enter a start frame, end frame & increment, and all frames in that subset
-will be converted. For example: entering 0, 50 and 10 for the first frame, last
-frame, and increment respectively will convert frames 0, 10, 20, 30, 40 & 50.
+will be converted. For example, entering 0, 50 and 10 will convert frames 0, 
+10, 20, 30, 40 & 50.
+
 To convert a single frame, enter the same value for first frame & last frame,
 and 1 as the increment.
@@ -54 +55 @@
 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.
+frame to its own file. The single file option will produce one file with
+multiple `<SASdata>` elements. The multiple file option will output a separate 
+file with one `<SASdata>` element for each frame. The frame number will also be 
+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.
+The multiple file option is not available when exporting to NXcanSAS because 
+the HDF5 format is more efficient at handling large amounts of data.
+
+
+.. note::
+    This help document was last changed by Steve King, 08Oct2016