Skip to content
Snippets Groups Projects
Commit 1c926c45 authored by Peterson, Peter's avatar Peterson, Peter
Browse files

Re #9776. Adding properties directive to fit functions.

parent 701a2e04
No related branches found
No related tags found
No related merge requests found
Showing
with 40 additions and 32 deletions
......@@ -13,4 +13,6 @@ Abragam fitting function for use by Muon scientists defined by
.. math:: \mbox{A}\times cos( 2 \pi \times {Omega} \times {x} + {Phi} ) \times \exp(-{Sigma}^2 \times Tau^2 \times {x}^2 \times ( exp ( {x} / Tau ) - 1 + {x} / Tau ) )
.. properties::
.. categories::
......@@ -21,4 +21,6 @@ interpolation points. The parameter names have the form 'yi' where 'y'
is letter 'y' and 'i' is the parameter's index starting from 0 and have
the type double. Likewise, the attribute names have the form 'xi'.
.. properties::
.. categories::
......@@ -41,13 +41,13 @@ peak:
.. figure:: /images/BackToBackExponentialWithConstBackground.png
:alt: BackToBackExponentialWithConstBackground.png
BackToBackExponentialWithConstBackground.png
Properties
----------
*Note the initial default guesses for in particular A and B are only
based on fitting a couple of peaks in a dataset collected on the ISIS's
HRPD instrument.*
.. note:: the initial default guesses for in particular A and B are only
based on fitting a couple of peaks in a dataset collected on the ISIS's
HRPD instrument.
.. properties::
.. categories::
......@@ -64,4 +64,6 @@ square or contiguous subregion of a panel
The values for out in function1D are, for each pixel, the difference of
V(see formula) and dataY(0).
.. properties::
.. categories::
......@@ -35,4 +35,6 @@ index starting from 0.
The other two attributes are doubles 'StartX' and 'EndX' which define
the expansion (fitting) interval.
.. properties::
.. categories::
......@@ -15,4 +15,6 @@ motions of molecules. The Chudley-Elliot Jump diffusion model (1961) has the for
.. math:: Gamma(Q) = (1 - sin(Ql)/Ql)/tau
.. properties::
.. categories::
......@@ -65,4 +65,6 @@ inner one in brackets:
``name=LinearBackground;(composite=Convolution;name=Resolution;name=Lorentzian)``
.. properties::
.. categories::
......@@ -33,13 +33,11 @@ box function:
.. figure:: /images/Convolution.png
:alt: Convolution.png
Convolution.png
Note that the box function is defined on interval [-5, 5]:
.. figure:: /images/Box.png
:alt: Box.png
Box.png
.. properties::
.. categories::
......@@ -21,4 +21,6 @@ interpolation points. The parameter names have the form 'yi' where 'y'
is letter 'y' and 'i' is the parameter's index starting from 0 and have
the type double. Likewise, the attribute names have the form 'xi'.
.. properties::
.. categories::
......@@ -118,17 +118,6 @@ Then:
</center>
Properties
----------
+---------+-------------+-----------+-----------------------------------------------------------------------------------------+
| Order | Name | Default | Description |
+=========+=============+===========+=========================================================================================+
| 1 | Intensity | 1.0 | Intensity of the peak [arbitrary units] |
+---------+-------------+-----------+-----------------------------------------------------------------------------------------+
| 2 | Radius | 1.0 | Circle radius [Angstroms] |
+---------+-------------+-----------+-----------------------------------------------------------------------------------------+
| 3 | Decay | 1.0 | inverse of the transition rate (ps if energy in meV; ns if energy in :math:`\mu`\ eV) |
+---------+-------------+-----------+-----------------------------------------------------------------------------------------+
.. properties::
.. categories::
......@@ -52,17 +52,6 @@ The fit function DiffSphere has an elastic part, modelled by fitting
function ElasticDiffSphere and an inelastic part, modelled by
InelasticDiffSphere.
Properties
----------
+---------+-------------+-----------+----------------------------------------------------------------------------+
| Order | Name | Default | Description |
+=========+=============+===========+============================================================================+
| 1 | Intensity | 1.0 | Intensity of the peak [arbitrary units] |
+---------+-------------+-----------+----------------------------------------------------------------------------+
| 2 | Radius | 2.0 | Sphere radius [Å] |
+---------+-------------+-----------+----------------------------------------------------------------------------+
| 3 | Diffusion | 0.05 | Diffusion constant [Å\ :math:`{}^2/ps \equiv 10 \cdot (10^{-5} cm^2/s)`] |
+---------+-------------+-----------+----------------------------------------------------------------------------+
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ Exponential decay function is defined by
.. math:: \mbox{Height}\times \exp(-\frac{x}{\mbox{Lifetime}})
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ Exponential decay for use by Muon scientists defined by
.. math:: \mbox{A}\times \exp(-{Lambda} \times {x})
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ Oscillation exponential decay function is defined by
.. math:: \mbox{A}\times \exp(-{Lambda} \times {x}) \times cos( 2 \pi \times {Frequency} \times {x} + {Phi} )
.. properties::
.. categories::
......@@ -15,4 +15,6 @@ motions of molecules. Fick's law for diffusion has the form:
.. math:: Gamma(Q) = D*Q^2 where D=<l^2>*Q^2/6*tau
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ A Flat background function is defined as:
:math:`y = A_0`
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ Gaussian decay for use by Muon scientists defined by
.. math:: \mbox{A}\times \exp(-{Sigma}^2 \times {x}^2 )
.. properties::
.. categories::
......@@ -13,4 +13,6 @@ Oscillating Gaussian decay for use by Muon scientists defined by
.. math:: \mbox{A}\times \exp(-{Sigma}^2 \times {x}^2) \times cos( 2 \pi \times {Frequency} \times {x} + {Phi} )
.. properties::
.. categories::
......@@ -29,4 +29,6 @@ a TOF peak:
.. figure:: /images/GaussianWithConstBackground.png
:alt: GaussianWithConstBackground.png
.. properties::
.. categories::
......@@ -15,4 +15,6 @@ motions of molecules. The Hall-Ross Jump diffusion model has the form:
.. math:: Gamma(Q) = (1-exp(-l*Q^2))/tau
.. properties::
.. categories::
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment