|
29 | 29 | <doc> |
30 | 30 | Container for parameters used in processing or analysing data. |
31 | 31 |
|
32 | | - This base class can be used in a number of different contexts, |
33 | | - and is allowed in any other base class. However, a common use |
34 | | - case is to store the results of optimizing parameters, for |
35 | | - example, by least-squares fitting, so a number of attributes |
36 | | - have been defined for this purpose. Normally, this group will be |
37 | | - stored in a :ref:`NXprocess group`, which defines the program |
38 | | - used to process these parameters. If multiple functions are used |
39 | | - to analyze the data, there can be additional NXparameter groups |
40 | | - for each one. |
| 32 | + Typically, this group is stored in a :ref:`NXprocess` group in |
| 33 | + order to contain parameters that are either inputs to or |
| 34 | + resulting from the process defined by the parent group. However, |
| 35 | + this base class can also be added to other groups for use in |
| 36 | + other contexts. |
| 37 | + |
| 38 | + The base class defines a number of attributes that can be used |
| 39 | + if the parameter values result from, e.g., fitting a function or |
| 40 | + model to the measured data. If multiple functions are used, |
| 41 | + there can be additional NXparameter groups for each one. |
41 | 42 | </doc> |
42 | 43 | <attribute name="model"> |
43 | 44 | <doc> |
44 | | - The name of the model used in optimizing the data. Fitting |
45 | | - packages such as LMFIT (https://lmfit.github.io/lmfit-py/) |
46 | | - provide models, which instantiate functions to be fitted to |
47 | | - the data. If this attribute is provided, it is assumed that |
48 | | - all the parameters in this group are associated with this |
49 | | - model. |
| 45 | + The name of the model used in optimizing the parameter |
| 46 | + values. Fitting packages such as LMFIT |
| 47 | + (https://lmfit.github.io/lmfit-py/) provide models, which |
| 48 | + instantiate functions to be fitted to the data. If this |
| 49 | + attribute is provided, it is assumed that all the parameters |
| 50 | + in this group are associated with this model. |
50 | 51 | </doc> |
51 | 52 | </attribute> |
52 | | - <field name="TERM" type="NX_CHAR_OR_NUMBER" nameType="any"> |
| 53 | + <field name="PARAMETER" type="NX_CHAR_OR_NUMBER" nameType="any"> |
53 | 54 | <doc> |
54 | 55 | A parameter that is used in or results from processing. |
55 | 56 | </doc> |
56 | 57 | <attribute name="units" /> |
57 | 58 | <attribute name="error" type="NX_NUMBER"> |
58 | 59 | <doc> |
59 | | - The standard deviation resulting from data optimization. |
| 60 | + The standard deviation of the parameter after optimizing |
| 61 | + its value. |
60 | 62 | </doc> |
61 | 63 | </attribute> |
62 | 64 | <attribute name="expression"> |
|
70 | 72 | </attribute> |
71 | 73 | <attribute name="initial_value" type="NX_NUMBER"> |
72 | 74 | <doc> |
73 | | - The initial value of the parameter. |
| 75 | + The initial value of the parameter used in optimization. |
74 | 76 | </doc> |
75 | 77 | </attribute> |
76 | 78 | <attribute name="max" type="NX_NUMBER"> |
77 | 79 | <doc> |
78 | | - The upper bound of the parameter value. |
| 80 | + The upper bound of the parameter used in optimization. |
79 | 81 | </doc> |
80 | 82 | </attribute> |
81 | 83 | <attribute name="min" type="NX_NUMBER"> |
82 | 84 | <doc> |
83 | | - The lower bound of the parameter value. |
| 85 | + The lower bound of the parameter used in optimization. |
84 | 86 | </doc> |
85 | 87 | </attribute> |
86 | 88 | <attribute name="vary" type="NX_BOOLEAN"> |
87 | 89 | <doc> |
88 | | - True if the parameter was varied in the fitting |
89 | | - procedure. |
| 90 | + True if the parameter was varied during optimization. |
90 | 91 | </doc> |
91 | 92 | </attribute> |
92 | 93 | </field> |
|
0 commit comments