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

.. index::
    ! NXsample_component_set (base class)
    ! sample_component_set (base class)
    see: sample_component_set (base class); NXsample_component_set

.. _NXsample_component_set:

======================
NXsample_component_set
======================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Set of sample components and their configuration. ...

      Set of sample components and their configuration.

      The idea here is to have a united place for all materials descriptors that are not 
      part of the individual sample components, but rather their configuration.

**Symbols**:


  **n_comp**: number of components

**Groups cited**:
  :ref:`NXsample_component_set`, :ref:`NXsample_component`

.. index:: NXsample_component (base class); used in base class, NXsample_component_set (base class); used in base class

**Structure**:

  .. _/NXsample_component_set@components-attribute:

  .. index:: components (file attribute)

  **@components**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Array of strings referring to the names of the NXsample_components. ...

        Array of strings referring to the names of the NXsample_components.
        The order of these components serves as an index (starting at 1).

  .. _/NXsample_component_set/concentration-field:

  .. index:: concentration (field)

  **concentration**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Concentration of each component

  .. _/NXsample_component_set/volume_fraction-field:

  .. index:: volume_fraction (field)

  **volume_fraction**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Volume fraction of each component

  .. _/NXsample_component_set/scattering_length_density-field:

  .. index:: scattering_length_density (field)

  **scattering_length_density**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Scattering length density of each component

  .. _/NXsample_component_set/SAMPLE_COMPONENT-group:

  **SAMPLE_COMPONENT**: (optional) :ref:`NXsample_component` 

    Each component set can contain multiple components.

  .. _/NXsample_component_set/SAMPLE_COMPONENT_SET-group:

  **SAMPLE_COMPONENT_SET**: (optional) :ref:`NXsample_component_set` 

    For description of a sub-component set. Can contain multiple components itself.


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

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


* :ref:`/NXsample_component_set/concentration-field </NXsample_component_set/concentration-field>`
* :ref:`/NXsample_component_set/SAMPLE_COMPONENT-group </NXsample_component_set/SAMPLE_COMPONENT-group>`
* :ref:`/NXsample_component_set/SAMPLE_COMPONENT_SET-group </NXsample_component_set/SAMPLE_COMPONENT_SET-group>`
* :ref:`/NXsample_component_set/scattering_length_density-field </NXsample_component_set/scattering_length_density-field>`
* :ref:`/NXsample_component_set/volume_fraction-field </NXsample_component_set/volume_fraction-field>`
* :ref:`/NXsample_component_set@components-attribute </NXsample_component_set@components-attribute>`

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