NXcalibration

Status:

base class, extends NXobject

Description:

Draft subclass of NXprocess to describe post-processing calibrations.

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays

ncoeff

nfeat

ncal

Groups cited:

NXcollection

Structure:

applied: (optional) NX_BOOLEAN

Has the calibration been applied?

coefficients[ncoeff]: (optional) NX_FLOAT {units=NX_ANY}

For non-linear energy calibrations, e.g. in a TOF, a polynomial function is fit to a set of features (peaks) at well defined energy positions to determine E(TOF). Here we can store the array of fit coefficients.

fit_function: (optional) NX_CHAR

For non-linear energy calibrations. Here we can store the formula of the fit function.

scaling: (optional) NX_FLOAT {units=NX_ANY}

For linear calibration. Scaling parameter.

offset: (optional) NX_FLOAT {units=NX_ANY}

For linear calibration. Offset parameter.

calibrated_axis[ncal]: (optional) NX_FLOAT {units=NX_ANY}

A vector representing the axis after calibration, matching the data length

conversion_table[ncal, ncal]: (optional) NX_FLOAT {units=NX_ANY}

2 vectors, representing how the raw points get mapped on the calibrated axis.

COLLECTION: (optional) NXcollection

Class to describe freely the procedures employed.

Hypertext Anchors

Table of hypertext anchors for all groups, fields, attributes, and links defined in this class.

documentation (reST source) anchor

web page (HTML) anchor

/NXcalibration/applied-field

#nxcalibration-applied-field

/NXcalibration/calibrated_axis-field

#nxcalibration-calibrated-axis-field

/NXcalibration/coefficients-field

#nxcalibration-coefficients-field

/NXcalibration/COLLECTION-group

#nxcalibration-collection-group

/NXcalibration/conversion_table-field

#nxcalibration-conversion-table-field

/NXcalibration/fit_function-field

#nxcalibration-fit-function-field

/NXcalibration/offset-field

#nxcalibration-offset-field

/NXcalibration/scaling-field

#nxcalibration-scaling-field

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/base_classes/NXcalibration.nxdl.xml