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

.. index::
    ! NXdispersion_table (base class)
    ! dispersion_table (base class)
    see: dispersion_table (base class); NXdispersion_table

.. _NXdispersion_table:

==================
NXdispersion_table
==================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  A dispersion table denoting energy, dielectric function tabulated values.

**Symbols**:

  The symbols in this schema to denote the dimensions

  **n_points**: The number of energy and dielectric function points

**Groups cited**:
  none

**Structure**:

  .. _/NXdispersion_table/model_name-field:

  .. index:: model_name (field)

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

    The name of this dispersion model.

  .. _/NXdispersion_table/convention-field:

  .. index:: convention (field)

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

    .. collapse:: The sign convention being used (n + or - ik) ...

        The sign convention being used (n + or - ik)

        Any of these values: ``n + ik`` | ``n - ik``

  .. _/NXdispersion_table/wavelength-field:

  .. index:: wavelength (field)

  **wavelength**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_points]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: The wavelength array of the tabulated dataset. ...

        The wavelength array of the tabulated dataset.
        This is essentially a duplicate of the energy field.
        There should be one or both of them present.

  .. _/NXdispersion_table/energy-field:

  .. index:: energy (field)

  **energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_points]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} 

    .. collapse:: The energy array of the tabulated dataset. ...

        The energy array of the tabulated dataset.
        This is essentially a duplicate of the wavelength field.
        There should be one or both of them present.

  .. _/NXdispersion_table/refractive_index-field:

  .. index:: refractive_index (field)

  **refractive_index**: (optional) :ref:`NX_COMPLEX <NX_COMPLEX>` (Rank: 1, Dimensions: [n_points]) {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    The refractive index array of the tabulated dataset.

  .. _/NXdispersion_table/dielectric_function-field:

  .. index:: dielectric_function (field)

  **dielectric_function**: (optional) :ref:`NX_COMPLEX <NX_COMPLEX>` (Rank: 1, Dimensions: [n_points]) {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    The dielectric function of the tabulated dataset.


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

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


* :ref:`/NXdispersion_table/convention-field </NXdispersion_table/convention-field>`
* :ref:`/NXdispersion_table/dielectric_function-field </NXdispersion_table/dielectric_function-field>`
* :ref:`/NXdispersion_table/energy-field </NXdispersion_table/energy-field>`
* :ref:`/NXdispersion_table/model_name-field </NXdispersion_table/model_name-field>`
* :ref:`/NXdispersion_table/refractive_index-field </NXdispersion_table/refractive_index-field>`
* :ref:`/NXdispersion_table/wavelength-field </NXdispersion_table/wavelength-field>`

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