source: sasview/src/sas/sasgui/perspectives/calculator/media/slit_calculator_help.rst @ 82d88d5

magnetic_scattrelease-4.2.2ticket-1009ticket-1249
Last change on this file since 82d88d5 was 346745a, checked in by smk78, 6 years ago

Overhauled slit_calculator_help. Fixes #897

  • Property mode set to 100644
File size: 1.9 KB
RevLine 
[ec392464]1.. slit_calculator_help.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
[8a22b5b]6
[ec392464]7Slit Size Calculator Tool
8=========================
9
10Description
11-----------
[8a22b5b]12
[346745a]13This tool enables X-ray users to calculate the slit size (FWHM/2) for resolution
14smearing purposes based on their half beam profile data (as Q vs Intensity; any
15other data fields are ignored).
16
17Method
18------
19
20The tool works by sequentially summing 10 or more intensity values until a
21maximum value is attained. It then locates the Q values for the points just before,
22and just after, **half** of this maximum value and interpolates between them to get
23an accurate value for the Q value for the half maximum.
[8a22b5b]24
[170b251]25NOTE! Whilst it may have some more generic applicability, the calculator has
[346745a]26only been tested with beam profile data from Anton-Paar SAXSess\ :sup:`TM`\  software.
27The beam profile file does not carry any information about the units of the
28Q data. It is probably |nm^-1| but the resolution calculations assume the slit
29height/width has units of |Ang^-1|. If the beam profile data is not in these
30units then it, or the result, must be manually converted.
[ec392464]31
32.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
33
[a9dc4eb]34Using the tool
35--------------
[ec392464]36
[8a22b5b]371) Select *Slit Size Calculator* from the *Tool* menu on the SasView toolbar.
38
392) Load a beam profile file in the *Data* field using the *Browse* button.
40
[5ed76f8]41   *NOTE! To see an example of the beam profile file format, visit the file
[346745a]42   beam profile.DAT in your {installation_directory}/SasView/test_1d folder.*
[8a22b5b]43
[5ed76f8]443) Once a data is loaded, the slit size is automatically computed and displayed
[8a22b5b]45   in the tool window.
[ec392464]46
[8a22b5b]47.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[ec392464]48
[346745a]49.. note::  This help document was last changed by Steve King, 09Sep2018
Note: See TracBrowser for help on using the repository browser.