Ignore:
Timestamp:
Feb 19, 2015 11:20:54 AM (10 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, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
0721c3d
Parents:
6271222
Message:

Proof read.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/sas/perspectives/calculator/media/slit_calculator_help.rst

    rec392464 r8a22b5b  
    33.. This is a port of the original SasView html help file to ReSTructured text 
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
     5 
     6.. |Ang| unicode:: U+212B 
     7.. |TM| unicode:: U+2122 
    58 
    69Slit Size Calculator Tool 
     
    912Description 
    1013----------- 
    11 This tool is for X-ray users to calculate the slit size (FWHM/2) for smearing  
    12 based on their half beam profile data (SAXSess). 
     14 
     15This tool enables X-ray users to calculate the slit size (FWHM/2) for smearing  
     16based on their half beam profile data. 
     17 
     18*NOTE! Whilst it may have some more generic applicability, the calculator has 
     19only been tested with beam profile data from Anton-Paar SAXSess*\ |TM|\   
     20*software.* 
    1321 
    1422.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    1624How To 
    1725------- 
    18 To calculate the slit size (FWHM/2), just load the beam profile data using the  
    19 browse button. 
    2026 
    21 Once a data is loaded, the slit size will be computed and show up in the text  
    22 box. 
     271) Select *Slit Size Calculator* from the *Tool* menu on the SasView toolbar. 
    2328 
    24 Because the unit is not specified in the data file, we do not convert it into  
    25 1/Angstrom so  users are responsible for converting the units of their data. 
     292) Load a beam profile file in the *Data* field using the *Browse* button. 
    2630 
    27 Note: This slit size calculator only works for beam profile data produced by  
    28 'SAXSess'. 
     31   *NOTE! To see an example of the beam profile file format, visit the file  
     32   beam profile.DAT in your {installation_directory}/SasView/test folder.* 
    2933 
    30 To see the file format, check the file, 'beam profile.DAT', in the 'test'  
    31 folder of SasView. 
     343) Once a data is loaded, the slit size is automatically computed and displayed  
     35   in the tool window. 
     36 
     37*NOTE! The beam profile file does not carry any information about the units of  
     38the Q data. This calculator assumes the data has units of 1/\ |Ang| . If the  
     39data is not in these units it must be manually converted beforehand.* 
     40 
     41.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     42 
     43.. note::  This help document was last changed by Steve King, 19Feb2015 
Note: See TracChangeset for help on using the changeset viewer.