Changeset 94f4518 in sasview for src/sas/sasgui/perspectives/file_converter/media/file_converter_help.rst

Timestamp:

Jul 21, 2016 11:53:53 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:

a3c538e1

Parents:

eb8da5f

Message:

Add option to export multiple frames as one file or multiple files

File:

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

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

@@ -12 +12 @@
 The input files can be:
 
-*   Single column ASCII data, with lines that end with a digit, comma or
-    semi-colon.
+*   Single column ASCII data, with lines that end with a digit (no delimiter),
+    comma or semi-colon.
 *   `BSL/OTOKO formatted
     <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
@@ -29 +29 @@
 5) Click *Convert* to save the converted file to disk
 
-**Note**: 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. To convert a single frame, enter the same value for first
-frame & last frame, and 1 as the increment.
+Files With Multiple Frames
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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.
+To convert a single frame, enter the same value for first frame & last frame,
+and 1 as the increment.
+
+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.