Ignore:
Timestamp:
Oct 8, 2016 11:07:32 AM (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:
1 edited

Legend:

Unmodified
Added
Removed

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

    rda456fb rd73998c  
    99----------- 
    1010 
    11 This tool converts file formats with the Q data and intensity data in separate 
    12 files, into a single CanSAS XML or NXcanSAS HDF5 file. 
     11This tool converts file formats with the Q data and Intensity data stored in separate 
     12files, into a single CanSAS (XML) or NXcanSAS (HDF5) file. 
    1313 
    14 It can also convert 2D BSL files into NXcanSAS HDF5 files. 
     14It can also convert 2D BSL/OTOKO files into a NXcanSAS file. 
    1515 
    16 Supported input file formats: 
     16Supported input file formats (examples may be found in the /test/convertible_files folder): 
    1717 
    18 *   Single column ASCII data, with lines that end with a digit (no delimiter), 
    19     comma or semi-colon. 
    20 *   `One-Dimensional OTOKO formatted 
     18*   Single-column ASCII data, with lines that end without any delimiter, 
     19    or with a comma or semi-colon delimiter 
     20*   `1D BSL/OTOKO format 
    2121    <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ 
    22     SAXS-Software/CCP13/XOTOKO.html>`_ data. 
    23 *   `Two-Dimensional BSL formatted 
     22    SAXS-Software/CCP13/BSL.html>`_ data 
     23*   `2D BSL/OTOKO format 
    2424    <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ 
    25     SAXS-Software/CCP13/BSL.html>`_ data. 
     25    SAXS-Software/CCP13/BSL.html>`_ data 
    2626 
    27 Supported output file formats@ 
     27Supported output file formats: 
    2828 
    29 *   `CanSAS XML <http://www.cansas.org/formats/canSAS1d/1.1/doc/>`_ 
    30 *   `NXcanSAS HDF5 <http://download.nexusformat.org/sphinx/classes/contributed_definitions/NXcanSAS.html>`_ 
     29*   `CanSAS <http://www.cansas.org/formats/canSAS1d/1.1/doc/>`_ 
     30*   `NXcanSAS <http://download.nexusformat.org/sphinx/classes/contributed_definitions/NXcanSAS.html>`_ 
    3131 
    3232.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    … …  
    3535-------------- 
    3636 
    37 1) Select the files containing your Q-Axis and Intensity-Axis data 
    38 2) Chose whether the files are in ASCII, OTOKO or BSL format 
    39 3) Chose where you would like to save the converted file 
     371) Select the files containing your Q-axis and Intensity-axis data 
     382) Choose whether the files are in ASCII, 1D BSL/OTOKO or 2D BSL/OTOKO format 
     393) Choose where you would like to save the converted file 
    40404) Optionally, input some metadata such as sample size, detector name, etc 
    41 5) Click *Convert* to save the converted file to disk 
     415) Click *Convert* to save the converted file 
    4242 
    4343Files With Multiple Frames 
    4444^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    4545 
    46 If a BSL/OTOKO file with multiple frames is selected for the intensity-axis 
     46If a BSL/OTOKO file with multiple frames is selected for the Intensity-axis 
    4747file, a dialog will appear asking which frames you would like converted. You 
    4848may enter a start frame, end frame & increment, and all frames in that subset 
    49 will be converted. For example: entering 0, 50 and 10 for the first frame, last 
    50 frame, and increment respectively will convert frames 0, 10, 20, 30, 40 & 50. 
     49will be converted. For example, entering 0, 50 and 10 will convert frames 0,  
     5010, 20, 30, 40 & 50. 
     51 
    5152To convert a single frame, enter the same value for first frame & last frame, 
    5253and 1 as the increment. 
    … …  
    5455CanSAS XML files can become quite large when exporting multiple frames to a 
    5556single file, so there is an option in the *Select Frame* dialog to output each 
    56 frame to it's own file. The single file option will produce one file with 
    57 multiple `<SASdata>` elements. The multiple file option will output a file for 
    58 each frame; each file will have one `<SASdata>` element, and the frame number 
    59 will appended to the file name. 
     57frame to its own file. The single file option will produce one file with 
     58multiple `<SASdata>` elements. The multiple file option will output a separate  
     59file with one `<SASdata>` element for each frame. The frame number will also be  
     60appended to the file name. 
    6061 
    61 The multiple file option is not available when exporting to NXcanSAS. All 
    62 frames will be written to the same file, since the HDF5 format is designed for 
    63 handling large amounts of data. 
     62The multiple file option is not available when exporting to NXcanSAS because  
     63the HDF5 format is more efficient at handling large amounts of data. 
     64 
     65 
     66.. note:: 
     67    This help document was last changed by Steve King, 08Oct2016 
Note: See TracChangeset for help on using the changeset viewer.