You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/experiment/experiment.rst
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -30,19 +30,19 @@ To be able to compute reflectivities it is also necessary to have a `calculator`
30
30
model.interface = interface
31
31
32
32
This will create a :py:class:`Model` instance with the `default_sample` and the environment variables `scale` factor set to 1.0 and a `background` of 1e-6.
33
-
Following the `interface` is set to the default calculator.
33
+
Following the `interface` is set to the default calculator that is `Refnx`.
34
34
35
35
36
36
:py:mod:`resolution_functions`
37
37
------------------------------
38
-
A resolution function enables the `EasyReflectometry` model to account for various nonideal effects that might be present in the experimental setup.
39
-
When determining reflectivity the resolution function defines the smearing to apply.
40
-
For a given Q point such smearing is applied by determining an average of the neighboring Q point weigthed by a normal distribution,
41
-
which has a Q point dependent Full Width at the Half Maximum (FWHM) that again is defined by the resolution function.
38
+
A resolution function enables the `EasyReflectometry` model to account for various non-ideal effects that might be present in the experimental setup.
39
+
In its essence the resolution function controls the smearing to apply when determing the reflectivtiy at a given Q point.
40
+
For a given Q point the smearing to apply is given as a weigthed average of the neighboring Q point, which weigths are by a normal distribution.
41
+
This normal distribution is then defined by a Q point dependent Full Width at the Half Maximum (FWHM) that is given by the resolution function.
42
42
43
43
:py:func:`percentage_fhwm_resolution_function`
44
44
Often we rely on a resolution function that has a simple functional dependecy of the Q point.
45
-
By this is understood that the applied smearing in an Q point has a FWHM that is given as a percentage of the value of the Q point.
45
+
By this is understood that the applied smearing in an Q point has a FWHM that is simply a percentage of the value of the Q point.
46
46
47
47
.. code-block:: python
48
48
@@ -55,7 +55,7 @@ By this is understood that the applied smearing in an Q point has a FWHM that is
55
55
resolution_function=resolution_function
56
56
)
57
57
58
-
This will create a :py:class:`Model` instance where a resolution function is defined that has a FWHM that is 1% of the Q point value.
58
+
This will create a :py:class:`Model` instance where the resolution function is defined as 1% of the Q point value, which again is the FWHM for the smearing.
59
59
60
60
61
61
:py:func:`linear_spline_resolution_function`
@@ -77,5 +77,5 @@ and thereby enable a determination of the reflectivity at an arbitrary point wit
77
77
78
78
m.resolution_function = resolution_function
79
79
80
-
This will create a :py:class:`Model` instance where a resolution function is defined that has a FWHM that is determined from a linear interpolation.
81
-
In the present case the provided data points are (`[0.01, 0.2, 0.31]`) and the corresponding function values are (`[0.001, 0.043, 0.026]`).
80
+
This will create a :py:class:`Model` instance where the resolution function defining the FWHM is determined from a linear interpolation.
81
+
In the present case the provided data Q points are (`[0.01, 0.2, 0.31]`) and the corresponding FWHM function values are (`[0.001, 0.043, 0.026]`).
0 commit comments