Changeset eb8da5f in sasview for docs/sphinx-docs

Timestamp:

Jul 21, 2016 10:47:25 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:

94f4518

Parents:

8976865

Message:

Support loading BSL/OTOKO files with multiple frames

Location:

docs/sphinx-docs/source/user

Files:

• sasgui/perspectives/file_converter/file_converter_help.rst (modified) (2 diffs)
• tools.rst (modified) (1 diff)

docs/sphinx-docs/source/user/sasgui/perspectives/file_converter/file_converter_help.rst

@@ -14 +14 @@
 *   Single column ASCII data, with lines that end with a digit, comma or
     semi-colon.
-*   `BSL formatted
+*   `BSL/OTOKO formatted
     <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/
-    SAXS-Software/CCP13/BSL.html>`_ data files
+    SAXS-Software/CCP13/BSL.html>`_ data files.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -23 +23 @@
 --------------
 
-1) Select the files containing your Q-Axis and Intensity data
+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
 4) Optionally, input some metadata such as sample size, detector name, etc
 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.

docs/sphinx-docs/source/user/tools.rst

@@ -8 +8 @@
 
    Data Operations Utility <sasgui/perspectives/calculator/data_operator_help>
-      
+
    Density/Volume Calculator <sasgui/perspectives/calculator/density_calculator_help>
-   
+
    Generic SANS Calculator <sasgui/perspectives/calculator/sas_calculator_help>
-   
+
    Image Viewer <sasgui/perspectives/calculator/image_viewer_help>
-   
+
    Kiessig Thickness Calculator <sasgui/perspectives/calculator/kiessig_calculator_help>
-   
+
    SLD Calculator <sasgui/perspectives/calculator/sld_calculator_help>
-   
+
    Slit Size Calculator <sasgui/perspectives/calculator/slit_calculator_help>
-   
+
    Q Resolution Estimator <sasgui/perspectives/calculator/resolution_calculator_help>
-   
+
    Python Shell <sasgui/perspectives/calculator/python_shell_help>
-   
+
+   File Converter <sasgui/perspectives/file_converter/file_converter_help>