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

.. index::
    ! NXisocontour (base class)
    ! isocontour (base class)
    see: isocontour (base class); NXisocontour

.. _NXisocontour:

============
NXisocontour
============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Base class for describing isocontouring/phase-fields in Euclidean space. ...

      Base class for describing isocontouring/phase-fields in Euclidean space.

      Iso-contouring algorithms such as Marching Cubes and others are frequently
      used to segment d-dimensional regions at crossings of a threshold value,
      the so-called isovalue.

      In Computational Materials Science phase-field methods are frequently used.
      Phase-field variables are discretized frequently using regular grids.

      Isocontour algorithms are often used in such context to pinpoint the
      locations of microstructural features from this implicit phase-field-
      variable-value-based description.

      One of the key intentions of this base class is to provide a starting point
      for scientists from the phase-field community (condensed-matter physicists,
      and materials engineers) to incentivize that also phase-field (and other)
      simulation data can take advantage of NeXus base class to improve
      interoperability.

**Symbols**:

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

  **d**: The dimensionality of the description.

**Groups cited**:
  :ref:`NXcg_grid`

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

**Structure**:

  .. _/NXisocontour/dimensionality-field:

  .. index:: dimensionality (field)

  **dimensionality**: (optional) :ref:`NX_POSINT <NX_POSINT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: The dimensionality of the space in which the isocontour is embedded. ...

        The dimensionality of the space in which the isocontour is embedded.

        Any of these values: ``1`` | ``2`` | ``3``

  .. _/NXisocontour/isovalue-field:

  .. index:: isovalue (field)

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

    The threshold or iso-contour value.

  .. _/NXisocontour/grid-group:

  **grid**: (optional) :ref:`NXcg_grid` 

    The discretized grid on which the iso-contour algorithm operates.


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

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


* :ref:`/NXisocontour/dimensionality-field </NXisocontour/dimensionality-field>`
* :ref:`/NXisocontour/grid-group </NXisocontour/grid-group>`
* :ref:`/NXisocontour/isovalue-field </NXisocontour/isovalue-field>`

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