Changeset d3e1870 in sasview


Ignore:
Timestamp:
Aug 19, 2016 7:34:50 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:
fdd3ba1
Parents:
bec6cb8
Message:

Update file converter docs to reflect NXcanSAS implementation

Location:
src/sas/sasgui/perspectives/file_converter
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/perspectives/file_converter/converter_panel.py

    rbec6cb8 rd3e1870  
    499499        "files containing the Q-Axis and Intensity-Axis data, or a 2D BSL file" 
    500500        ", then chose where to save the converted file, and click Convert.\n" 
    501         "ASCII and OTOKO files will be converted to CanSAS XML, and OTKO files" 
    502         " to IGOR/DAT 2D Q_map files.\nCanSAS metadata can also be optionally " 
    503         "input below.") 
     501        "ASCII and OTOKO files can be converted to CanSAS XML, or NXcanSAS " 
     502        "HDF5 format. OTOKO files can only be converted to NXcanSAS.\nCanSAS " 
     503        "metadata can also be optionally input below.") 
    504504 
    505505        instruction_label = wx.StaticText(self, -1, instructions, 
  • src/sas/sasgui/perspectives/file_converter/media/file_converter_help.rst

    rebc1407 rd3e1870  
    88 
    99This tool converts file formats with the Q data and intensity data in separate 
    10 files, into a single CanSAS XML file. 
     10files, into a single CanSAS XML or NXcanSAS HDF5 file. 
    1111 
    12 It can also convert 2D BSL files into IGOR/DAT 2D files, which are 3 column 
    13 ASCII files of the format :code:`Qx - Qy - I(Qx,Qy)`. 
     12It can also convert 2D BSL files into NXcanSAS HDF5 files. 
    1413 
    1514The input files can be: 
     
    4645and 1 as the increment. 
    4746 
    48 For OTOKO files, there is also the option to output the data as multiple frames 
    49 in a single CanSAS file, or multiple files with one frame each. The single file 
    50 option will produce one file with multiple `<SASdata>` elements. The multiple 
    51 file 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. 
     47CanSAS XML files can become quite large when exporting multiple frames to a 
     48single file, so there is an option in the *Select Frame* dialog to output each 
     49frame to it's own file. The single file option will produce one file with 
     50multiple `<SASdata>` elements. The multiple file option will output a file for 
     51each frame; each file will have one `<SASdata>` element, and the frame number 
     52will appended to the file name. 
    5353 
    54 All converted BSL frames will have the frame number appended to the file name. 
     54The multiple file option is not available when exporting to NXcanSAS. All 
     55frames will be written to the same file, since the HDF5 format is designed for 
     56handling large amounts of data. 
Note: See TracChangeset for help on using the changeset viewer.