Skip to content

Commit 11996cf

Browse files
rayosbornPeterC-DLS
authored andcommitted
Add text to emphasize that this base class is not exclusively to store fitting parameters.
1 parent 470a363 commit 11996cf

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

base_classes/NXparameters.nxdl.xml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@
3535
this base class can also be added to other groups for use in
3636
other contexts.
3737

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.
38+
Although this base class can be used to store any kind of
39+
parameter, one possible use case is to store parameters that are
40+
refined by a fitting function or model. A number of attributes
41+
have been defined to store metadata associated with such a
42+
refinment.
4243
</doc>
4344
<attribute name="model">
4445
<doc>
@@ -61,6 +62,11 @@
6162
its value.
6263
</doc>
6364
</attribute>
65+
<attribute name="description">
66+
<doc>
67+
A description of what this parameter represents.
68+
</doc>
69+
</attribute>
6470
<attribute name="expression">
6571
<doc>
6672
A string representing an expression that can be used to
@@ -75,12 +81,12 @@
7581
The initial value of the parameter used in optimization.
7682
</doc>
7783
</attribute>
78-
<attribute name="max" type="NX_NUMBER">
84+
<attribute name="max_value" type="NX_NUMBER">
7985
<doc>
8086
The upper bound of the parameter used in optimization.
8187
</doc>
8288
</attribute>
83-
<attribute name="min" type="NX_NUMBER">
89+
<attribute name="min_value" type="NX_NUMBER">
8490
<doc>
8591
The lower bound of the parameter used in optimization.
8692
</doc>

0 commit comments

Comments
 (0)