.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/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`, :ref:`NXparameters`

.. index:: NXnote (base class); used in base class, NXdata (base class); used in base class, NXparameters (base class); used in base class, NXcalibration (base class); used in base class

**Structure**:

  .. _/NXresolution/physical_quantity-field:

  .. index:: physical_quantity (field)

  **physical_quantity**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: The physical quantity of the resolution, e.g., ...

        The physical quantity of the resolution, e.g.,
        energy, momentum, time, area, etc.

  .. _/NXresolution/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <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 <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    The resolution of the physical quantity.

  .. _/NXresolution/resolution_errors-field:

  .. index:: resolution_errors (field)

  **resolution_errors**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <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 <NX_FLOAT>` {units=\ :ref:`NX_ANY <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 <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    Standard deviation of the relative resolution of the physical quantity.

  .. _/NXresolution/resolution_formula_description-field:

  .. index:: resolution_formula_description (field)

  **resolution_formula_description**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: A description of the resolution formula to determine the resolution from a set ...

        A description of the resolution formula to determine the resolution from a set of symbols as
        entered by the `formula_...` fields. This should be an english description of the math used.

  .. _/NXresolution/note-group:

  **note**: (optional) :ref:`NXnote` :ref:`⤆ </NXobject/NOTE-group>`

    Additional details of the estimate or description of the calibration procedure

  .. _/NXresolution/response_function-group:

  **response_function**: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    .. collapse:: The response of the instrument or part of the instrument to a infinitesimally  ...

        The response of the instrument or part of the instrument 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.

        This could have an AXISNAME field ```input``` (the input axis or grid of the response function)
        and a ``DATA`` field ```magnitude```. Both of these should have the same unit. The dimensions
        should match those of the :ref:`resolution </NXresolution/resolution-field>` field.

  .. _/NXresolution/formula_symbols-group:

  **formula_symbols**: (optional) :ref:`NXparameters` :ref:`⤆ </NXobject/PARAMETERS-group>`

    .. collapse:: Symbols linking to another path in the NeXus tree to be referred to from the ...

        Symbols linking to another path in the NeXus tree to be referred to from the
        `resolution_formula_description` field. The ``TERM``  should be a valid path inside this application
        definition, i.e., of the form /entry/instrument/my_part/my_field.

  .. _/NXresolution/CALIBRATION-group:

  :bolditalic:`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 </NXresolution/CALIBRATION-group>`
* :ref:`/NXresolution/formula_symbols-group </NXresolution/formula_symbols-group>`
* :ref:`/NXresolution/note-group </NXresolution/note-group>`
* :ref:`/NXresolution/physical_quantity-field </NXresolution/physical_quantity-field>`
* :ref:`/NXresolution/relative_resolution-field </NXresolution/relative_resolution-field>`
* :ref:`/NXresolution/relative_resolution_errors-field </NXresolution/relative_resolution_errors-field>`
* :ref:`/NXresolution/resolution-field </NXresolution/resolution-field>`
* :ref:`/NXresolution/resolution_errors-field </NXresolution/resolution_errors-field>`
* :ref:`/NXresolution/resolution_formula_description-field </NXresolution/resolution_formula_description-field>`
* :ref:`/NXresolution/response_function-group </NXresolution/response_function-group>`
* :ref:`/NXresolution/type-field </NXresolution/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXresolution.nxdl.xml