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

Timestamp:

Aug 10, 2016 6:18:59 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:

ca6659f

Parents:

18544f8

Message:

Update documentation to include 2D BSL functionality

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

@@ -10 +10 @@
 files, into a single CanSAS XML 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)`.
+
 The input files can be:
 
 *   Single column ASCII data, with lines that end with a digit (no delimiter),
     comma or semi-colon.
-*   `BSL/OTOKO formatted
+*   `One-Dimensional OTOKO formatted
+    <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
+    SAXS-Software/CCP13/XOTOKO.html>`_ data files.
+*   `Two-Dimensional BSL formatted
     <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
     SAXS-Software/CCP13/BSL.html>`_ data files.
@@ -24 +30 @@
 
 1) Select the files containing your Q-Axis and Intensity-Axis data
-2) Chose whether the files are in ASCII or BSL format
-3) Chose where you would like to save the converted XML file
+2) Chose whether the files are in ASCII, OTOKO or BSL format
+3) Chose 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
@@ -40 +46 @@
 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.
+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.
+
+All converted BSL frames will have the frame number appended to the file name.