source: sasview/src/sas/sasgui/perspectives/calculator/media/slit_calculator_help.rst @ 643efb5

magnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249unittest-saveload
Last change on this file since 643efb5 was 643efb5, checked in by butler, 6 years ago

Minor edits to sli_calcutaor_help.rst

Fix superscript on TM .. but sphinx may not be recognizing and does not
seem to recognize substitutions either. Should be subject of another
ticket.

  • Property mode set to 100644
File size: 1.4 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
[5ed76f8]13This tool enables X-ray users to calculate the slit size (FWHM/2) for smearing
[8a22b5b]14based on their half beam profile data.
15
16*NOTE! Whilst it may have some more generic applicability, the calculator has
[643efb5]17only been tested with beam profile data from Anton-Paar SAXSess\ :sup:`TM` software.*
[ec392464]18
19.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
20
[a9dc4eb]21Using the tool
22--------------
[ec392464]23
[8a22b5b]241) Select *Slit Size Calculator* from the *Tool* menu on the SasView toolbar.
25
262) Load a beam profile file in the *Data* field using the *Browse* button.
27
[5ed76f8]28   *NOTE! To see an example of the beam profile file format, visit the file
[8a22b5b]29   beam profile.DAT in your {installation_directory}/SasView/test folder.*
30
[5ed76f8]313) Once a data is loaded, the slit size is automatically computed and displayed
[8a22b5b]32   in the tool window.
[ec392464]33
[5ed76f8]34*NOTE! The beam profile file does not carry any information about the units of
[a9dc4eb]35the Q data. This calculator assumes the data has units of 1/\ |Ang|\ . If the
[8a22b5b]36data is not in these units it must be manually converted beforehand.*
[ec392464]37
[8a22b5b]38.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[ec392464]39
[a9dc4eb]40.. note::  This help document was last changed by Steve King, 01May2015
Note: See TracBrowser for help on using the repository browser.