Changeset 3aa3351 in sasview


Ignore:
Timestamp:
May 18, 2018 7:47:15 AM (7 months ago)
Author:
celinedurniak <celine.durniak@…>
Branches:
ESS_GUI, ESS_GUI_Invariant, ESS_GUI_Pr_fixes, ESS_GUI_batch_fitting, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_ordering
Children:
085e3c9d
Parents:
b10cf92
Message:

Documentation for Q resolution calculator updated

Location:
src/sas/qtgui/Calculators/media
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/qtgui/Calculators/media/resolution_calculator_help.rst

    r417c03f r3aa3351  
    1010----------- 
    1111 
    12 This tool is approximately estimates the resolution of $Q$ from SAS instrumental 
     12This tool approximately estimates the resolution of $Q$ from SAS instrumental 
    1313parameter values assuming that the detector is flat and normal to the 
    1414incident beam. 
     
    1919-------------- 
    2020 
    21 1) Select *SAS Resolution Estimator* from the *Tool* menu on the SasView toolbar. 
     211) Select *Q Resolution Estimator* from the *Tool* menu on the SasView toolbar. 
    2222 
    23 2) Select the source (Neutron or Photon) and source type (Monochromatic or TOF). 
     232) Select the source and source type (Monochromatic or TOF). 
    2424 
    2525   *NOTE! The computational difference between the sources is only the 
     
    3535   range. 
    3636 
    37    Optionally, the wavelength (BUT NOT of the wavelength spread) can be extended 
     37   Optionally, the wavelength (BUT NOT the wavelength spread) can be extended 
    3838   by adding '; nn' where the 'nn' specifies the number of the bins for the 
    3939   numerical integration. The default value is nn = 10. The same number of bins 
     
    49497) 1D and 2D $dQ$ values will be displayed at the bottom of the panel, and a 2D 
    5050   resolution weight distribution (a 2D elliptical Gaussian function) will also 
    51    be displayed in the plot panel even if the $Q$ inputs are outside of the 
    52    detector limit (the red lines indicate the limits of the detector). 
     51   be displayed in the plot panel. 
    5352 
    5453   TOF only: green lines indicate the limits of the maximum $Q$ range accessible 
    5554   for the longest wavelength due to the size of the detector. 
    5655 
    57    Note that the effect from the beam block/stop is ignored, so in the small $Q$ 
     56   Note that the effect from the beam block/stop is ignored. So, in the small $Q$ 
    5857   region near the beam block/stop 
    5958 
     
    6362 
    64638) A summary of the calculation is written to the SasView *Console* at the 
    65    bottom of the main SasView window. 
     64   bottom of the main SasView window, below the plot. 
    6665 
    67 .. image:: resolution_tutor.png 
     66.. figure:: resolution_tutor.png 
     67 
     68   .. 
     69 
     70   1) Define the source. Select *Photon* for X-ray. This selection only affects 
     71      the gravitational contribution of the resolution 
     72   2) Select between *Monochromatic* or *TOF* 
     73   3) For *TOF*, there is the option 
     74      of loading a custom spectral distribution using *Add New* in the combo 
     75      box 
     76   4) *Wavelength* and *wavelength spread*: one value for *Monochromatic*, 
     77      minimum and maximum of range for *TOF* 
     78   5) For *Source* and *Sample Size Aperture*, one value for a circular 
     79      aperture (diameter) and two values separated by a comma (,) for a 
     80      rectangular slit (side lengths) 
     81   6) One value for one ($Qx$, $Qy$) location or more values separated by a 
     82      comma (,) for more locations. *Note: the $Qx$, $Qy$ input boxes should 
     83      have the same number of values.* 
     84   7) Click on *Compute* button to start the calculation 
     85   8) *Sigma_x* and *Sigma_y* are the components of the 2D $dQ$ at the last 
     86      ($Qx$, $Qy$) point of inputs 
     87   9) *Sigma_lamd* is the 2D $dQ_{\lambda}$ at the last point of inputs. 
     88      *Note: $dQ_{\lambda}$ has only the Qr directional component* 
     89   10) *(1D Sigma)* is the 1D $dQ$ at the last ($Qx$, $Qy$) point of inputs 
     90   11) Plot of the result. For *TOF*, a green rectangle marks the limits of 
     91       maximum $Q$  range accessible for the longest wavelength due to the 
     92       size of the detector. 
    6893 
    6994.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
  • src/sas/qtgui/Calculators/media/resolution_tutor.png

    • Property mode changed from 100755 to 100644
Note: See TracChangeset for help on using the changeset viewer.