.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXms_snapshot_set.nxdl.xml

.. index::
    ! NXms_snapshot_set (base class)
    ! ms_snapshot_set (base class)
    see: ms_snapshot_set (base class); NXms_snapshot_set

.. _NXms_snapshot_set:

=================
NXms_snapshot_set
=================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  A collection of spatiotemporal microstructure data.

**Symbols**:

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

**Groups cited**:
  :ref:`NXms_snapshot`

.. index:: NXms_snapshot (base class); used in base class

**Structure**:

  .. _/NXms_snapshot_set/comment-field:

  .. index:: comment (field)

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

    Is this set describing a measurement or a simulation?

    Any of these values: ``measurement`` | ``simulation``

  .. _/NXms_snapshot_set/identifier_offset-field:

  .. index:: identifier_offset (field)

  **identifier_offset**: (optional) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Integer which specifies the first index to be used for distinguishing
    snapshots. Identifiers are defined either implicitly
    or explicitly. For implicit indexing the identifiers are defined on the
    interval [identifier_offset, identifier_offset+c-1].
    For explicit indexing the identifier array has to be defined.

    The identifier_offset field can for example be used to communicate if the
    identifiers are expected to start from 1 (referred to as Fortran-/Matlab-)
    or from 0 (referred to as C-, Python-style index notation) respectively.

  .. _/NXms_snapshot_set/MS_SNAPSHOT-group:

  **MS_SNAPSHOT**: (optional) :ref:`NXms_snapshot`



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

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


* :ref:`/NXms_snapshot_set/comment-field </NXms_snapshot_set/comment-field>`
* :ref:`/NXms_snapshot_set/identifier_offset-field </NXms_snapshot_set/identifier_offset-field>`
* :ref:`/NXms_snapshot_set/MS_SNAPSHOT-group </NXms_snapshot_set/MS_SNAPSHOT-group>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXms_snapshot_set.nxdl.xml