Changeset 2f539b2 in sasview


Ignore:
Timestamp:
May 16, 2018 5:35:45 AM (5 months ago)
Author:
celinedurniak <celine.durniak@…>
Branches:
ESS_GUI, ESS_GUI_Pr_fixes, ESS_GUI_image_viewer, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_project_save
Children:
085e3c9d
Parents:
d1fa2b8
Message:

Updated documentation for generic sans calculator

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

Legend:

Unmodified
Added
Removed
  • src/sas/qtgui/Calculators/media/gen_gui_help.png

    • Property mode changed from 100755 to 100644
  • src/sas/qtgui/Calculators/media/sas_calculator_help.rst

    r417c03f r2f539b2  
    2424 
    2525Assuming that all the pixel sizes are the same, the elastic scattering 
    26 intensity from the particle is 
     26intensity from the particle is defined as 
    2727 
    2828.. image:: gen_i.png 
     
    3333the position of the $j^\text{th}$ pixel respectively. 
    3434 
    35 The total volume $V$ 
     35The total volume $V$ is equal to 
    3636 
    3737.. math:: 
     
    4343density * Avogadro number) for the atomic structures). 
    4444 
    45 $V$ can be corrected by users. This correction is useful especially for an 
    46 atomic structure (such as taken from a PDB file) to get the right normalization. 
    47  
    48 *NOTE! $\beta_j$ displayed in the GUI may be incorrect but this will not 
    49 affect the scattering computation if the correction of the total volume V is made.* 
     45$V$ can be corrected by users (input parameter `Total volume`). This correction 
     46is useful especially for an atomic structure (such as taken from a PDB file) 
     47to get the right normalization. 
     48 
     49*NOTE! $\beta_j$ displayed in the GUI may be incorrect (input parameter 
     50`solvent_SLD`) but this will not affect the scattering computation if the 
     51correction of the total volume V is made.* 
    5052 
    5153The scattering length density (SLD) of each pixel, where the SLD is uniform, is 
     
    99101.. image:: mxp.png 
    100102 
     103 
     104 
    101105.. image:: myp.png 
    102106 
     107 
     108 
    103109.. image:: mzp.png 
    104110 
     111 
     112 
    105113.. image:: mqx.png 
    106114 
     115 
     116 
    107117.. image:: mqy.png 
    108118 
    109 Here the $M0_x$, $M0_y$ and $M0_z$ are the $x$, $y$ and $z$ 
     119Here the $M_{0x}$, $M_{0y}$ and $M_{0z}$ are the $x$, $y$ and $z$ 
    110120components of the magnetisation vector in the laboratory $xyz$ frame. 
     121 
     122 
     123.. .. image:: Mxyzp.png 
     124 
    111125 
    112126.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    115129-------------- 
    116130 
    117 .. image:: gen_gui_help.png 
    118  
    119 After computation the result will appear in the *Theory* box in the SasView 
     131.. figure:: gen_gui_help.png 
     132 
     133   .. 
     134 
     135   1) Load .sld, .txt, or .omf datafile 
     136   2) Select default shape of sample 
     137   3) Draw magnetization with arrows (not recommended for a large number of 
     138      pixels). 
     139   4) Ratio of (+/total) neutrons after analyser 
     140   5) Ratio of (+/total) neutrons before sample 
     141   6) Polarization angle in degrees 
     142   7) Default volume calculated from the pixel info 
     143      (or natural density of pdf file) 
     144   8) Compute the scattering pattern 
     145   9) Reset GUI to initial state 
     146   10) Display mean values or enter a new value if enabled 
     147   11) Save the sld data as sld format 
     148 
     149.. After computation the result will appear in the *Theory* box in the SasView 
    120150*Data Explorer* panel. 
    121151 
     
    126156of neutrons before the sample and at the analyzer, respectively. 
    127157 
    128 *NOTE 1. The values of* Up_frac_in *and* Up_frac_out *must be in the range 
     158*NOTE 1. The values of Up_frac_in and Up_frac_out must be in the range 
    1291590.0 to 1.0. Both values are 0.5 for unpolarized neutrons.* 
    130160 
     
    133163 
    134164*NOTE 3. For the nuclear scattering length density, only the real component 
    135 is taken account.* 
     165is taken into account.* 
    136166 
    137167.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    151181 
    152182where $v_j \beta_j \equiv b_j$ is the scattering 
    153 length of the $j^\text{th}$ atom. The calculation output is passed to the *Data Explorer* 
     183length of the $j^\text{th}$ atom. 
     184.. The calculation output is passed to the *Data Explorer* 
    154185for further use. 
    155186 
    156 .. image:: pdb_combo.jpg 
     187.. figure:: pdb_combo.png 
     188 
     189   .. 
     190 
     191   1) PDB file loaded 
     192   2) disabled input for *Up_frac_in*, *Up_frac_oupt*, *Up_theta* 
     193   3) option to perform the calculations using "Fixed orientations" (2D output) 
     194      or "Averaging over all orientations using Debye equation" (1D output). 
     195      This choice is only available for PDB files. 
     196 
     197 
    157198 
    158199.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
Note: See TracChangeset for help on using the changeset viewer.