.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXpeak.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXpeak (base class)
    ! peak (base class)
    see: peak (base class); NXpeak

.. _NXpeak:

======
NXpeak
======

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Base class for describing a peak, its functional form, and support values ...

      Base class for describing a peak, its functional form, and support values
      i.e., the discretization points at which the function has been evaluated.

**Symbols**:

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

  **dimRank**: Rank of the dependent and independent data arrays (for multivariate scalar-valued fit).

**Groups cited**:
  :ref:`NXdata`, :ref:`NXfit_function`

.. index:: NXdata (base class); used in base class, NXfit_function (base class); used in base class

**Structure**:

  .. _/NXpeak/label-field:

  .. index:: label (field)

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

    .. collapse:: Human-readable label which specifies which concept/entity ...

        Human-readable label which specifies which concept/entity
        the peak represents/identifies.

  .. _/NXpeak/total_area-field:

  .. index:: total_area (field)

  **total_area**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Total area under the curve.

  .. _/NXpeak/data-group:

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


    .. _/NXpeak/data/position-field:

    .. index:: position (field)

    **position**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: dimRank) {units=\ :ref:`NX_ANY <NX_ANY>`} 

      .. collapse:: Position values along one or more data dimensions (to hold the ...

          Position values along one or more data dimensions (to hold the
          values for the independent variable).

    .. _/NXpeak/data/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: dimRank) {units=\ :ref:`NX_ANY <NX_ANY>`} 

      This array holds the intensity/count values of the fitted peak at each position.

  .. _/NXpeak/function-group:

  **function**: (optional) :ref:`NXfit_function` 

    .. collapse:: The functional form of the peak. This could be a Gaussian, Lorentzian, Voigt, ...

        The functional form of the peak. This could be a Gaussian, Lorentzian, Voigt,
        etc.


Hypertext Anchors
-----------------

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


* :ref:`/NXpeak/data-group </NXpeak/data-group>`
* :ref:`/NXpeak/data/intensity-field </NXpeak/data/intensity-field>`
* :ref:`/NXpeak/data/position-field </NXpeak/data/position-field>`
* :ref:`/NXpeak/function-group </NXpeak/function-group>`
* :ref:`/NXpeak/label-field </NXpeak/label-field>`
* :ref:`/NXpeak/total_area-field </NXpeak/total_area-field>`

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