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


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r94f4518 rebc1407  
    1010files, into a single CanSAS XML file. 
    1111 
     12It can also convert 2D BSL files into IGOR/DAT 2D files, which are 3 column 
     13ASCII files of the format :code:`Qx - Qy - I(Qx,Qy)`. 
     14 
    1215The input files can be: 
    1316 
    1417*   Single column ASCII data, with lines that end with a digit (no delimiter), 
    1518    comma or semi-colon. 
    16 *   `BSL/OTOKO formatted 
     19*   `One-Dimensional OTOKO formatted 
     20    <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ 
     21    SAXS-Software/CCP13/XOTOKO.html>`_ data files. 
     22*   `Two-Dimensional BSL formatted 
    1723    <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ 
    1824    SAXS-Software/CCP13/BSL.html>`_ data files. 
    … …  
    2430 
    25311) Select the files containing your Q-Axis and Intensity-Axis data 
    26 2) Chose whether the files are in ASCII or BSL format 
    27 3) Chose where you would like to save the converted XML file 
     322) Chose whether the files are in ASCII, OTOKO or BSL format 
     333) Chose where you would like to save the converted file 
    28344) Optionally, input some metadata such as sample size, detector name, etc 
    29355) Click *Convert* to save the converted file to disk 
    … …  
    4046and 1 as the increment. 
    4147 
    42 There is also the option to output the data as multiple frames in a single 
    43 CanSAS file, or multiple files with one frame each. The single file option will 
    44 produce one file with multiple `<SASdata>` elements. The multiple file option 
    45 will output a file for each frame; each file will have one `<SASdata>` element, 
    46 and the frame number will appended to the file name. 
     48For OTOKO files, there is also the option to output the data as multiple frames 
     49in a single CanSAS file, or multiple files with one frame each. The single file 
     50option will produce one file with multiple `<SASdata>` elements. The multiple 
     51file option will output a file for each frame; each file will have one 
     52`<SASdata>` element, and the frame number will appended to the file name. 
     53 
     54All converted BSL frames will have the frame number appended to the file name. 
Note: See TracChangeset for help on using the changeset viewer.