3.3.1.120. NXparameters¶
Status:
base class, extends NXobject
Description:
Container for parameters used in processing or analysing data. ...
Container for parameters used in processing or analysing data.
Typically, this group is stored in a NXprocess group in order to contain parameters that are either inputs to or resulting from the process defined by the parent group. However, this base class can also be added to other groups for use in other contexts.
Although this base class can be used to store any kind of parameter, one possible use case is to store parameters that are refined by a fitting function or model. A number of attributes have been defined to store metadata associated with such a refinement.
Symbols:
No symbol table
- Groups cited:
none
Structure:
@model: (optional) NX_CHAR
The name of the model used in optimizing the parameter ...
The name of the model used in optimizing the parameter values. Fitting packages such as LMFIT (https://lmfit.github.io/lmfit-py/) provide models, which instantiate functions to be fitted to the data. If this attribute is provided, it is assumed that all the parameters in this group are associated with this model.
PARAMETER: (optional) NX_CHAR_OR_NUMBER
A parameter that is used in or results from processing.
@units: (optional) NX_CHAR
@error: (optional) NX_NUMBER
The standard deviation of the parameter after optimizing ...
The standard deviation of the parameter after optimizing its value.
@description: (optional) NX_CHAR
A description of what this parameter represents.
@expression: (optional) NX_CHAR
A string representing an expression that can be used to ...
A string representing an expression that can be used to relate the parameter to another parameter’s value. The format of this string is dependent on the program used to optimize the parameters and is not specified by NeXus.
@initial: (optional) NX_NUMBER
The initial value of the parameter used in optimization.
@max: (optional) NX_NUMBER
The upper bound of the parameter used in optimization.
@min: (optional) NX_NUMBER
The lower bound of the parameter used in optimization.
@vary: (optional) NX_BOOLEAN
True if the parameter was varied during optimization.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
