[11794f2] | 1 | .. file_converter_help.rst |
---|
| 2 | |
---|
| 3 | File Converter Tool |
---|
| 4 | =================== |
---|
| 5 | |
---|
| 6 | Description |
---|
| 7 | ----------- |
---|
| 8 | |
---|
| 9 | This tool converts file formats with the Q data and intensity data in separate |
---|
[d3e1870] | 10 | files, into a single CanSAS XML or NXcanSAS HDF5 file. |
---|
[11794f2] | 11 | |
---|
[d3e1870] | 12 | It can also convert 2D BSL files into NXcanSAS HDF5 files. |
---|
[ebc1407] | 13 | |
---|
[97e90b7] | 14 | Supported input file formats: |
---|
[11794f2] | 15 | |
---|
[94f4518] | 16 | * Single column ASCII data, with lines that end with a digit (no delimiter), |
---|
| 17 | comma or semi-colon. |
---|
[ebc1407] | 18 | * `One-Dimensional OTOKO formatted |
---|
| 19 | <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ |
---|
[97e90b7] | 20 | SAXS-Software/CCP13/XOTOKO.html>`_ data. |
---|
[ebc1407] | 21 | * `Two-Dimensional BSL formatted |
---|
[11794f2] | 22 | <http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/ |
---|
[97e90b7] | 23 | SAXS-Software/CCP13/BSL.html>`_ data. |
---|
| 24 | |
---|
| 25 | Supported output file formats@ |
---|
| 26 | |
---|
| 27 | * `CanSAS XML <http://www.cansas.org/formats/canSAS1d/1.1/doc/>`_ |
---|
| 28 | * `NXcanSAS HDF5 <http://download.nexusformat.org/sphinx/classes/contributed_definitions/NXcanSAS.html>`_ |
---|
[11794f2] | 29 | |
---|
| 30 | .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ |
---|
| 31 | |
---|
| 32 | Using the Tool |
---|
| 33 | -------------- |
---|
| 34 | |
---|
[eb8da5f] | 35 | 1) Select the files containing your Q-Axis and Intensity-Axis data |
---|
[ebc1407] | 36 | 2) Chose whether the files are in ASCII, OTOKO or BSL format |
---|
| 37 | 3) Chose where you would like to save the converted file |
---|
[11794f2] | 38 | 4) Optionally, input some metadata such as sample size, detector name, etc |
---|
| 39 | 5) Click *Convert* to save the converted file to disk |
---|
[eb8da5f] | 40 | |
---|
[94f4518] | 41 | Files With Multiple Frames |
---|
| 42 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
---|
| 43 | |
---|
| 44 | If a BSL/OTOKO file with multiple frames is selected for the intensity-axis |
---|
| 45 | file, a dialog will appear asking which frames you would like converted. You |
---|
| 46 | may enter a start frame, end frame & increment, and all frames in that subset |
---|
| 47 | will be converted. For example: entering 0, 50 and 10 for the first frame, last |
---|
| 48 | frame, and increment respectively will convert frames 0, 10, 20, 30, 40 & 50. |
---|
| 49 | To convert a single frame, enter the same value for first frame & last frame, |
---|
| 50 | and 1 as the increment. |
---|
| 51 | |
---|
[d3e1870] | 52 | CanSAS XML files can become quite large when exporting multiple frames to a |
---|
| 53 | single file, so there is an option in the *Select Frame* dialog to output each |
---|
| 54 | frame to it's own file. The single file option will produce one file with |
---|
| 55 | multiple `<SASdata>` elements. The multiple file option will output a file for |
---|
| 56 | each frame; each file will have one `<SASdata>` element, and the frame number |
---|
| 57 | will appended to the file name. |
---|
[ebc1407] | 58 | |
---|
[d3e1870] | 59 | The multiple file option is not available when exporting to NXcanSAS. All |
---|
| 60 | frames will be written to the same file, since the HDF5 format is designed for |
---|
| 61 | handling large amounts of data. |
---|