Changeset 280f929 in sasview for src/sas/sasgui

Timestamp:

Oct 5, 2016 10:41:59 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:

3a22ce7

Parents:

ec860a8f

Message:

SESANS data format information added by Wim. Re-commit to the src
folder.

File:

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

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

@@ -3 +3 @@
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+.. WG Bouwman, DUT, added during CodeCamp-V in Oct 2016 the SESANS data format
 
 .. _Formats:
@@ -9 +10 @@
 ============
 
-SasView reads several different 1D (I(Q) vs Q) and 2D (I(Qx,Qy) vs (Qx,Qy))
+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.
 
-1D Formats
-----------
+1D Formats SANS
+---------------
 
 SasView will read files with 2 to 4 columns of numbers in the following order: 
@@ -46 +48 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-2D Formats
-----------
+2D Formats SANS
+---------------
 
 SasView will only read files in the NIST 2D format with the extensions 
@@ -60 +62 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 01May2015
+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)
+
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Wim Bouwman, 05Oct2016