source: sasview/src/sas/sasgui/guiframe/media/data_formats_help.rst @ 48b8f6d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 48b8f6d was 48b8f6d, checked in by smk78, 4 years ago

Updated with SESANS format by Wim, then thoroughly edited by Steve.
Information on NxcanSAS and File Converter added too. Closes #709

  • Property mode set to 100644
File size: 4.5 KB
RevLine 
[280f929]1.. data_formats.rst
2
3.. This is a port of the original SasView html help file to ReSTructured text
4.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
5.. WG Bouwman, DUT, added during CodeCamp-V in Oct 2016 the SESANS data format
6
7.. _Formats:
8
9Data Formats
10============
11
[48b8f6d]12SasView reads several different 1D SAS (*I(Q) vs Q*), 2D SAS(*I(Qx,Qy) vs (Qx,Qy)*) and 1D SESANS (*P(z) vs z*) data files. From SasView 4.1 onwards, a :ref:`File_Converter_Tool` allows some legacy formats to be converted into modern formats that SasView will read.
[280f929]13
[48b8f6d]141D SAS Formats
15--------------
[280f929]16
[48b8f6d]17SasView will read ASCII ('text') files with 2 to 4 columns of numbers in the following order:
[280f929]18
[48b8f6d]19    *Q, I(Q), ( dI(Q), dQ(Q) )*
[280f929]20   
[48b8f6d]21where *dQ(Q)* is the instrumental resolution in *Q* and assumed to have originated
[280f929]22from pinhole geometry.
23
24Numbers can be separated by spaces or commas.
25
[48b8f6d]26SasView recognises the following file extensions which are not case-sensitive:
[280f929]27
28*  .TXT
29*  .ASC
30*  .DAT
31*  .XML (in canSAS format v1.0 and 1.1)
32
[48b8f6d]33If using CSV output from, for example, a spreadsheet, ensure that it is not using commas as delimiters for thousands.
34
35The SasView :ref:`File_Converter_Tool` available in SasView 4.1 onwards can be used to convert data sets with separated *I(Q)* and *Q* files (for example, BSL/OTOKO, and some output from FIT2D and other SAXS-oriented software) into either the canSAS SASXML (XML) format or the NeXus NXcanSAS (HDF5) format.
[280f929]36
37For a description of the CanSAS/SASXML format see:
38http://www.cansas.org/formats/canSAS1d/1.1/doc/
39
[48b8f6d]40For a description of the ISIS 1D format see:
41http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf
42
43For a description of the NXcanSAS format see:
44http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html
45
46All the above formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_.
47
[280f929]48For a description of the NIST 1D format see:
49http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_IQ
50
[48b8f6d]51For a description of the BSL/OTOKO format see:
52http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html
[280f929]53
54.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
55
[48b8f6d]562D SAS Formats
57--------------
58
59SasView will read ASCII ('text') files in the NIST 2D format (with the extensions .ASC or .DAT) or files in the NeXus NXcanSAS (HDF5) format (with the extension .H5). File extensions are not case-sensitive. Both of these formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_.
[280f929]60
[48b8f6d]61Most of the header lines in the NIST 2D format can actually be removed except the last line, and only the first three columns (*Qx, Qy,* and *I(Qx,Qy)*) are actually required.
[280f929]62
[48b8f6d]63The SasView :ref:`File_Converter_Tool` available in SasView 4.1 onwards can be used to convert data sets in the 2D BSL/OTOKO format into the NeXus NXcanSAS (HDF5) format.
[280f929]64
65For a description of the NIST 2D format see:
66http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_2DQxQy
67
[48b8f6d]68For a description of the NXcanSAS format see:
69http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html
70
71For a description of the BSL/OTOKO format see: For a description of the BSL/OTOKO format see:
72http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html
73
74
[280f929]75.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
76
[48b8f6d]771D SESANS Format
78----------------
[280f929]79
[48b8f6d]80SasView version 4.1 onwards will read ASCII ('text') files in a prototype SESANS standard format (with the extensions .SES or .SESANS). The file extensions are not case-sensitive.
[280f929]81
[48b8f6d]82The file format has a list of name-value pairs at the top of the file which detail the general experimental parameters necessary for fitting and analyzing data. This list should contain all the information necessary for the file to be 'portable' between users.
[280f929]83
[48b8f6d]84Following the header is a 6 column list of instrument experimental variables:
[280f929]85
86- Spin echo length (z, in Angstroms)
[48b8f6d]87- Spin echo length error (:math:`\Delta`\ z, in Angstroms) (experimental resolution)
88- Neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments)
89- Neutron wavelength error (:math:`\Delta \lambda`, in Angstroms)
[280f929]90- Normalized polarization (:math:`P/P_0`, unitless)
91- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error)
92
93.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
94
[48b8f6d]95.. note::  This help document was last changed by Steve King, 07Oct2016
Note: See TracBrowser for help on using the repository browser.