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

.. index::
    ! NXcg_isocontour (base class)
    ! cg_isocontour (base class)
    see: cg_isocontour (base class); NXcg_isocontour

.. _NXcg_isocontour:

===============
NXcg_isocontour
===============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Computational geometry description of isocontouring/phase-fields in Euclidean space.

  Iso-contouring algorithms such as MarchingCubes and others are frequently
  used to segment d-dimensional regions into regions where intensities are
  lower or higher than a threshold value, the so-called isovalue.

  Frequently in computational materials science phase-field methods are
  used which generate data on discretized grids. Isocontour algorithms
  are often used in such context to pinpoint the locations of microstructural
  features from this implicit phase-field-variable-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 simulation
  data could be described with NeXus, provided base classes such as the this one
  get further extend according to the liking of the phase-field community.

**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**:

  .. _/NXcg_isocontour/dimensionality-field:

  .. index:: dimensionality (field)

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


  .. _/NXcg_isocontour/isovalue-field:

  .. index:: isovalue (field)

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

    The threshold or iso-contour value.

  .. _/NXcg_isocontour/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:`/NXcg_isocontour/dimensionality-field </NXcg_isocontour/dimensionality-field>`
* :ref:`/NXcg_isocontour/grid-group </NXcg_isocontour/grid-group>`
* :ref:`/NXcg_isocontour/isovalue-field </NXcg_isocontour/isovalue-field>`

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