.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXresolution.nxdl.xml -- DO NOT EDIT .. index:: ! NXresolution (base class) ! resolution (base class) see: resolution (base class); NXresolution .. _NXresolution: ============ NXresolution ============ **Status**: base class, extends :ref:`NXobject` **Description**: Describes the resolution of a physical quantity. **Symbols**: No symbol table **Groups cited**: :ref:`NXcalibration`, :ref:`NXdata`, :ref:`NXnote` .. index:: NXnote (base class); used in base class, NXdata (base class); used in base class, NXcalibration (base class); used in base class **Structure**: .. _/NXresolution@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXresolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` .. collapse:: The physical quantity of the resolution, e.g., ... The physical quantity of the resolution, e.g., energy, momentum, time, etc. .. _/NXresolution/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` .. collapse:: The process by which the resolution was determined. ... The process by which the resolution was determined. Any of these values: ``estimated`` | ``derived`` | ``calibrated`` | ``other`` .. _/NXresolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} The resolution of the physical quantity. .. _/NXresolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Standard deviation of the resolution of the physical quantity. .. _/NXresolution/relative_resolution-field: .. index:: relative_resolution (field) **relative_resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Ratio of the resolution at a specified measurand value to that measurand value, .. _/NXresolution/relative_resolution_errors-field: .. index:: relative_resolution_errors (field) **relative_resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} Standard deviation of the relative resolution of the physical quantity. .. _/NXresolution/formula_SYMBOL-field: .. index:: formula_SYMBOL (field) **formula_SYMBOL**: (optional) :ref:`NX_CHAR ` .. collapse:: A symbol linking to another path in this appdef to be referred to from the ... A symbol linking to another path in this appdef to be referred to from the `resolution_formula` field. This should be a valid path inside this application definition, i.e., of the form /entry/instrument/my_part/my_field. .. _/NXresolution/resolution_formula-field: .. index:: resolution_formula (field) **resolution_formula**: (optional) :ref:`NX_CHAR ` .. collapse:: A resolution formula to determine the resolution from a set of symbols as ... A resolution formula to determine the resolution from a set of symbols as entered by the `formula_...` fields. The output unit should match the provided unit of this field. .. _/NXresolution/note-group: **note**: (optional) :ref:`NXnote` Additional details of the estimate or description of the calibration procedure .. _/NXresolution/response_function-group: **response_function**: (optional) :ref:`NXdata` .. collapse:: The response of the instrument or part to a infinitesimally sharp input signal ... The response of the instrument or part to a infinitesimally sharp input signal along the physical quantity of this group. This is also sometimes called instrument response function for time resolution or point spread function for spatial response. The resolution is typically determined by taking the full width at half maximum (FWHM) of the response function. .. _/NXresolution/response_function/input-field: .. index:: input (field) **input**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: The input axis or grid of the response function. ... The input axis or grid of the response function. The unit should match the one of the resolution field. .. _/NXresolution/response_function/magnitude-field: .. index:: magnitude (field) **magnitude**: (optional) :ref:`NX_FLOAT ` .. collapse:: The magnitude of the response function corresponding to the points ... The magnitude of the response function corresponding to the points in the input axis or grid. This field should have the same dimensions as `input`. .. _/NXresolution/CALIBRATION-group: **CALIBRATION**: (optional) :ref:`NXcalibration` For storing details and data of a calibration to derive a resolution from data. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXresolution/CALIBRATION-group ` * :ref:`/NXresolution/formula_SYMBOL-field ` * :ref:`/NXresolution/note-group ` * :ref:`/NXresolution/physical_quantity-field ` * :ref:`/NXresolution/relative_resolution-field ` * :ref:`/NXresolution/relative_resolution_errors-field ` * :ref:`/NXresolution/resolution-field ` * :ref:`/NXresolution/resolution_errors-field ` * :ref:`/NXresolution/resolution_formula-field ` * :ref:`/NXresolution/response_function-group ` * :ref:`/NXresolution/response_function/input-field ` * :ref:`/NXresolution/response_function/magnitude-field ` * :ref:`/NXresolution/type-field ` * :ref:`/NXresolution@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXresolution.nxdl.xml