source: sasview/src/sas/perspectives/calculator/media/sas_calculator_help.rst @ ec392464

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since ec392464 was ec392464, checked in by smk78, 9 years ago

New ReST help files location for perspective help

  • Property mode set to 100644
File size: 4.6 KB
RevLine 
[ec392464]1.. sas_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
6.. |beta| unicode:: U+03B2
7.. |gamma| unicode:: U+03B3
8.. |theta| unicode:: U+03B8
9.. |mu| unicode:: U+03BC
10.. |sigma| unicode:: U+03C3
11.. |phi| unicode:: U+03C6
12
13.. |equiv| unicode:: U+2261
14.. |noteql| unicode:: U+2260
15
16Generic Scattering Calculator Tool
17==================================
18
19Polarization and Magnetic Scattering
20
21Theory_
22GUI_
23PDB_Data_
24
25.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
26
27.. _Theory:
28
29Theory
30------
31
32In general, a particle with a volume V can be described by an ensemble
33containing N 3-dimensional rectangular pixels where each pixels are much
34smaller than V. Assuming that all the pixel sizes are same, the elastic
35scattering intensity by the particle
36
37.. image:: gen_i.gif
38
39where /beta/jand rj are the scattering length density and the position of the
40j'th pixel respectively. And the total volume
41
42.. image:: v_j.gif
43
44for /beta/j/noteql/0 where vj is the volume of the j'th pixel (or the j'th
45natural atomic volume (= atomic mass/natural molar density/Avogadro number) for
46the atomic structures). The total volume V can be corrected by users. This
47correction is useful especially for an atomic structure (taken from a pdb file)
48to get the right normalization. Note that the /beta/j displayed in GUI may be
49incorrect but will not affect the scattering computation if the correction of
50the total volume is made. The scattering length density (SLD) of each pixel
51where the SLD is uniform, is a combination of the nuclear and magnetic SLDs and
52depends on the spin states of the neutrons as follows:For magnetic scattering,
53only the magnetization component, *M*perp, perpendicular to the scattering
54vector *Q* contributes to the the magnetic scattering length. (Figure below).
55
56.. image:: mag_vector.bmp
57
58The magnetic scattering length density is then
59
60.. image:: dm_eq.gif
61
62where /gamma/= -1.913 the gyromagnetic ratio, /mu/B is the Bohr magneton, r0 is
63the classical radius of electron, and */sigma/* is the Pauli spin.
64
65For polarized neutron, the magnetic scattering is depending on the spin states.
66
67Let's consider that the incident neutrons are polarised parallel (+)/
68anti-parallel (-) to the x' axis (See both Figures above). The possible
69out-coming states then are + and - states for both incident states, where
70
71- Non-spin flips: (+ +) and (- -)
72- Spin flips:     (+ -) and (- +)
73
74.. image:: gen_mag_pic.bmp
75
76Now, let's assume that the angles of the *Q*  vector and the spin-axis (x')
77from x-axis are /phi/ and /theta/up respectively (See Figure above). Then,
78depending upon the polarization (spin) state of neutrons, the scattering
79length densities, including the nuclear scattering length density (/beta/N)
80are given as, for non-spin-flips
81
82.. image:: sld1.gif
83
84and for spin-flips
85
86.. image:: sld2.gif
87
88where
89
90.. image:: mxp.gif
91
92.. image:: myp.gif
93
94.. image:: mzp.gif
95
96.. image:: mqx.gif
97
98.. image:: mqy.gif
99
100Here, the M0x, M0yand M0zare the x, y and z components of the magnetisation
101vector given in the xyz lab frame.
102
103.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
104
105.. _GUI:
106
107GUI
108---
109
110.. image:: gen_gui_help.bmp
111
112After the computation, the result will be listed in the 'Theory' box in the
113data explorer panel on the main window.The 'Up_frac_in' and 'Up_frac_out' are
114the ratio, (spin up) /(spin up + spin down) neutrons before the sample and at
115the analyzer, respectively.
116
117*Note I: The values of 'Up_frac_in' and 'Up_frac_out' must be in the range
118between 0 and 1. For example, both values are 0.5 for unpolarized neutrons.*
119
120*Note II: This computation is totally based on the pixel (or atomic) data
121fixed in the xyz coordinates. Thus no angular orientational averaging is
122considered.*
123
124*Note III: For the nuclear scattering length density, only the real component
125is taken account.*
126
127.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
128
129.. _PDB_Data:
130
131PDB Data
132--------
133
134This Generic scattering calculator also supports some pdb files without
135considering polarized/magnetic scattering so that the related parameters
136such as Up_*** will be ignored (see the Picture below). The calculation for
137fixed orientation uses (the first) Equation above resulting in a 2D output,
138whileas the scattering calculation averaged over all the orientations uses
139the Debye equation providing a 1D output
140
141.. image:: gen_debye_eq.gif
142
143where vj /beta/j /equiv/ bj the scattering length of the j'th atom. The resultant outputs
144will be displayed in the DataExplorer for further uses.
145
146.. image:: pdb_combo.jpg
Note: See TracBrowser for help on using the repository browser.