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

.. index::
    ! NXroi (base class)
    ! roi (base class)
    see: roi (base class); NXroi

.. _NXroi:

=====
NXroi
=====

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Base class to describe a region-of-interest analyzed.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXprocess`

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

**Structure**:

  .. _/NXroi/PROCESS-group:

  **PROCESS**: (optional) :ref:`NXprocess` 

    Details about processing steps.

    .. _/NXroi/PROCESS/sequence_index-field:

    .. index:: sequence_index (field)

    **sequence_index**: (optional) :ref:`NX_INT <NX_INT>` 



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

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


* :ref:`/NXroi/PROCESS-group </NXroi/PROCESS-group>`
* :ref:`/NXroi/PROCESS/sequence_index-field </NXroi/PROCESS/sequence_index-field>`

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