Changeset 346745a in sasview for src/sas

Timestamp:

Sep 9, 2018 5:25:43 AM (6 years ago)

Author:

smk78

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

b229a3b

Parents:

e873408

Message:

Overhauled slit_calculator_help. Fixes #897

File:

• src/sas/sasgui/perspectives/calculator/media/slit_calculator_help.rst (modified) (2 diffs)

src/sas/sasgui/perspectives/calculator/media/slit_calculator_help.rst

@@ -11 +11 @@
 -----------
 
-This tool enables X-ray users to calculate the slit size (FWHM/2) for smearing
-based on their half beam profile data.
+This tool enables X-ray users to calculate the slit size (FWHM/2) for resolution 
+smearing purposes based on their half beam profile data (as Q vs Intensity; any 
+other data fields are ignored).
+
+Method
+------
+
+The tool works by sequentially summing 10 or more intensity values until a 
+maximum value is attained. It then locates the Q values for the points just before, 
+and just after, **half** of this maximum value and interpolates between them to get 
+an accurate value for the Q value for the half maximum.
 
 NOTE! Whilst it may have some more generic applicability, the calculator has
-only been tested with beam profile data from Anton-Paar SAXSess\ :sup:`TM` software.
+only been tested with beam profile data from Anton-Paar SAXSess\ :sup:`TM`\  software.
+The beam profile file does not carry any information about the units of the 
+Q data. It is probably |nm^-1| but the resolution calculations assume the slit 
+height/width has units of |Ang^-1|. If the beam profile data is not in these 
+units then it, or the result, must be manually converted.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -27 +40 @@
 
    *NOTE! To see an example of the beam profile file format, visit the file
-   beam profile.DAT in your {installation_directory}/SasView/test folder.*
+   beam profile.DAT in your {installation_directory}/SasView/test_1d folder.*
 
 3) Once a data is loaded, the slit size is automatically computed and displayed
    in the tool window.
 
-NOTE! The beam profile file does not carry any information about the units of
-the Q data. This calculator assumes the data has units of 1/|Ang|. If the
-data is not in these units it must be manually converted beforehand.
-
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 01May2015
+.. note::  This help document was last changed by Steve King, 09Sep2018