source: sasview/src/sas/sasgui/perspectives/file_converter/media/file_converter_help.rst @ 64cdb0d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalcmagnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 64cdb0d was 59decb81, checked in by lewis, 7 years ago

Update file converter docs to include 2D ASCII data

  • Property mode set to 100644
File size: 2.7 KB

File Converter Tool

Description

This tool converts file formats with the Q data and Intensity data stored in separate files, into a single CanSAS (XML) or NXcanSAS (HDF5) file.

It can also convert 2D BSL/OTOKO files into a NXcanSAS file.

Supported input file formats (examples may be found in the /test/convertible_files folder):

Supported output file formats:

Using the Tool

  1. Select the files containing your Q-axis and Intensity-axis data
  2. Choose whether the files are in ASCII 1D, ASCII 2D, 1D BSL/OTOKO or 2D BSL/OTOKO format
  3. Choose 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

Files With Multiple Frames

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 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.

CanSAS XML files can become quite large when exporting multiple frames to a single file, so there is an option in the Select Frame dialog to output each frame to its own file. The single file option will produce one file with multiple <SASdata> elements. The multiple file option will output a separate file with one <SASdata> element for each frame. The frame number will also be appended to the file name.

The multiple file option is not available when exporting to NXcanSAS because the HDF5 format is more efficient at handling large amounts of data.

Note

This help document was last changed by Steve King, 08Oct2016

Note: See TracBrowser for help on using the repository browser.