@@ -27,14 +27,14 @@ subpackges, as shown below.
27
27
* .. py:class: : BaseFunction
28
28
29
29
+ .. py:class: : BaselineFunction
30
-
30
+
31
31
- .. py:class: : FromSequence
32
32
- .. py:class: : NanoSpherical
33
33
- .. py:class: : Polynomial
34
34
- *etc. *
35
-
35
+
36
36
+ .. py:class: : PeakFunction
37
-
37
+
38
38
- .. py:class: : Gaussian
39
39
- .. py:class: : GaussianOverR
40
40
- *etc. *
@@ -57,7 +57,7 @@ for examples.
57
57
.. py :method :: estimate_parameters(r, y)
58
58
59
59
Return a Numpy array of parameters estimated from the data.
60
-
60
+
61
61
:param r: Grid on which the data are defined.
62
62
:param y: The data.
63
63
:type r: `Sequence `
@@ -69,9 +69,9 @@ for examples.
69
69
70
70
71
71
.. py :method :: _jacobian_raw(pars, r, free)
72
-
72
+
73
73
Return Jacobian for parameters evaluated over `r `.
74
-
74
+
75
75
:param pars: The parameters of the baseline.
76
76
:param r: Scalar or grid on which to calculate the Jacobian.
77
77
:param free: Boolean values indicating if corresponding parameter is free (True) or fixed (False).
@@ -84,7 +84,7 @@ for examples.
84
84
.. py :method :: _transform_derivativesraw(pars, in_format, out_format)
85
85
86
86
Return the gradient matrix of `pars ` represented in format 'out_format'.
87
-
87
+
88
88
:param pars: The parameters of the baseline.
89
89
:param in_format: The format of `pars `.
90
90
:param out_format: The desired format of `pars `.
@@ -97,7 +97,7 @@ for examples.
97
97
.. py :method :: _transform_parametersraw(pars, in_format, out_format)
98
98
99
99
Return parameters transformed into format 'out_format'.
100
-
100
+
101
101
:param pars: The parameters of the baseline.
102
102
:param in_format: The format of `pars `.
103
103
:param out_format: The desired format of `pars `.
@@ -106,11 +106,11 @@ for examples.
106
106
:type out_format: `str `
107
107
:returns: The transformed parameters.
108
108
:rtype: `numpy.ndarray `
109
-
109
+
110
110
.. py :method :: _valueraw(pars, r)
111
111
112
112
Return value of baseline with given parameters at r.
113
-
113
+
114
114
:param pars: The parameters of the baseline.
115
115
:param r: Scalar or grid on which to calculate the baseline.
116
116
:type pars: `Sequence(float) `
@@ -130,12 +130,12 @@ following differences:
130
130
1) The ``estimate_parameters `` method is required.
131
131
2) The "position" key must be defined in the ``parameterdict `` class member.
132
132
3) Peak functions must implement the additional method ``scale_at ``.
133
-
133
+
134
134
.. py :method :: scale_at(pars, r, scale)
135
135
136
136
Return peak parameters such that the value at ``r `` is scaled by ``scale ``
137
137
while the position of the peak's maxima remains unchanged.
138
-
138
+
139
139
:param pars: The parameters of the peak.
140
140
:param r: Position where the peak will be rescaled.
141
141
:param scale: A scale factor > 0.
0 commit comments