Changeset 48b8f6d in sasview for src/sas/sasgui/guiframe/media

Timestamp:

Oct 7, 2016 3:49:07 PM (8 years ago)

Author:

smk78

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:

b61bd57, 18b7ecb9

Parents:

e82bb81

Message:

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

File:

• src/sas/sasgui/guiframe/media/data_formats_help.rst (modified) (2 diffs)

src/sas/sasgui/guiframe/media/data_formats_help.rst

@@ -10 +10 @@
 ============
 
-SasView reads several different 1D (I(Q) vs Q), 2D SANS(I(Qx,Qy) vs (Qx,Qy))
-and SESANS (P(z) vs z)
-data files. But please note that SasView does not at present load data where
-the Q and I(Q) data are in separate files.
+SasView 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.
 
-1D Formats SANS
----------------
+1D SAS Formats
+--------------
 
-SasView will read files with 2 to 4 columns of numbers in the following order: 
+SasView will read ASCII ('text') files with 2 to 4 columns of numbers in the following order: 
 
-    Q, I(Q), (dI(Q), dQ(Q))
+    *Q, I(Q), ( dI(Q), dQ(Q) )*
     
-where dQ(Q) is the instrumental resolution in Q and assumed to have originated 
+where *dQ(Q)* is the instrumental resolution in *Q* and assumed to have originated 
 from pinhole geometry.
 
 Numbers can be separated by spaces or commas.
 
-SasView recognises the following file extensions:
+SasView recognises the following file extensions which are not case-sensitive:
 
 *  .TXT
@@ -34 +31 @@
 *  .XML (in canSAS format v1.0 and 1.1)
 
-If using CSV output from, for example, a spreadsheet, ensure that it is not 
-using commas as delimiters for thousands.
+If using CSV output from, for example, a spreadsheet, ensure that it is not using commas as delimiters for thousands.
+
+The 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.
 
 For a description of the CanSAS/SASXML format see:
 http://www.cansas.org/formats/canSAS1d/1.1/doc/
 
+For a description of the ISIS 1D format see:
+http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf
+
+For a description of the NXcanSAS format see:
+http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html
+
+All the above formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_.
+
 For a description of the NIST 1D format see:
 http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_IQ
 
-For a description of the ISIS 1D format see:
-http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf
+For a description of the BSL/OTOKO format see: 
+http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-2D Formats SANS
----------------
+2D SAS Formats
+--------------
 
-SasView will only read files in the NIST 2D format with the extensions 
-.ASC or .DAT
+SasView 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/>`_.
 
-Most of the header lines can be removed except the last line, and only the 
-first three columns (Qx, Qy, and I(Qx,Qy)) are actually required.
+Most 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.
+
+The 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.
 
 For a description of the NIST 2D format see:
 http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_2DQxQy 
 
-.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+For a description of the NXcanSAS format see: 
+http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html
 
-SESANS Format
--------------
-
-The current file extension is .ses or .sesans (not case sensitive).
-
-The file format is to have a list of name-value pairs as a header at the top of the file, detailing general experimental parameters necessary for fitting and analyzing data. This list should contain all information necessary for the file to be 'portable' between users.
-
-Following that is a 6 column list of instrument experimental variables:
-
-- Spin echo length (z, in Angstroms)
-- Spin echo length error (:math:`\Delta` z, in Angstroms) (experimental resolution)
-- neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments)
-- neutron wavelength error (:math:`\Delta \lambda`, in Angstroms)
-- Normalized polarization (:math:`P/P_0`, unitless)
-- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error)
+For a description of the BSL/OTOKO format see: For a description of the BSL/OTOKO format see: 
+http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html
 
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Wim Bouwman, 05Oct2016
+1D SESANS Format
+----------------
+
+SasView 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.
+
+The 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.
+
+Following the header is a 6 column list of instrument experimental variables:
+
+- Spin echo length (z, in Angstroms)
+- Spin echo length error (:math:`\Delta`\ z, in Angstroms) (experimental resolution)
+- Neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments)
+- Neutron wavelength error (:math:`\Delta \lambda`, in Angstroms)
+- Normalized polarization (:math:`P/P_0`, unitless)
+- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error)
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 07Oct2016