.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcalibration.nxdl.xml -- DO NOT EDIT .. index:: ! NXcalibration (base class) ! calibration (base class) see: calibration (base class); NXcalibration .. _NXcalibration: ============= NXcalibration ============= .. Contributors List .. |contrib_name| replace:: Rubel|RubelMozumder|https://avatars.githubusercontent.com/u/32923026?v=4|2023-06-14 .. |contrib_name| replace:: Domna|domna|https://avatars.githubusercontent.com/u/1014422?v=4|2022-06-21 .. |contrib_name| replace:: Kuehbachm|mkuehbach|https://avatars.githubusercontent.com/u/14091504?v=4|2022-03-31 **Status**: base class, extends :ref:`NXobject` **Description**: Subclass of NXprocess to describe post-processing calibrations. **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays **ncoeff**: Number of coefficients of the calibration function **nfeat**: Number of features used to fit the calibration function **ncal**: Number of points of the calibrated and uncalibrated axes **Groups cited**: none **Structure**: .. _/NXcalibration/last_process-field: .. index:: last_process (field) **last_process**: (optional) :ref:`NX_CHAR ` Indicates the name of the last operation applied in the NXprocess sequence. .. _/NXcalibration/applied-field: .. index:: applied (field) **applied**: (optional) :ref:`NX_BOOLEAN ` Has the calibration been applied? .. _/NXcalibration/coefficients-field: .. index:: coefficients (field) **coefficients**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [ncoeff]) {units=\ :ref:`NX_ANY `} .. collapse:: For non-linear energy calibrations, e.g. in a TOF, a polynomial function is fi ... 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. .. _/NXcalibration/fit_function-field: .. index:: fit_function (field) **fit_function**: (optional) :ref:`NX_CHAR ` .. collapse:: For non-linear energy calibrations. Here we can store the formula of the ... For non-linear energy calibrations. Here we can store the formula of the fit function. Use a0, a1, ..., an for the coefficients, corresponding to the values in the coefficients field. Use x0, x1, ..., xn for the variables. The formula should be numpy compliant. .. _/NXcalibration/scaling-field: .. index:: scaling (field) **scaling**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} For linear calibration. Scaling parameter. .. _/NXcalibration/offset-field: .. index:: offset (field) **offset**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} For linear calibration. Offset parameter. .. _/NXcalibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [ncal]) {units=\ :ref:`NX_ANY `} A vector representing the axis after calibration, matching the data length .. _/NXcalibration/original_axis-field: .. index:: original_axis (field) **original_axis**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [ncal]) {units=\ :ref:`NX_ANY `} Vector containing the data coordinates in the original uncalibrated axis .. _/NXcalibration/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` A description of the procedures employed. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXcalibration/applied-field ` * :ref:`/NXcalibration/calibrated_axis-field ` * :ref:`/NXcalibration/coefficients-field ` * :ref:`/NXcalibration/description-field ` * :ref:`/NXcalibration/fit_function-field ` * :ref:`/NXcalibration/last_process-field ` * :ref:`/NXcalibration/offset-field ` * :ref:`/NXcalibration/original_axis-field ` * :ref:`/NXcalibration/scaling-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXcalibration.nxdl.xml