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

.. index::
    ! NXcg_roi (base class)
    ! cg_roi (base class)
    see: cg_roi (base class); NXcg_roi

.. _NXcg_roi:

========
NXcg_roi
========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Base class for a region-of-interest (ROI) bound by geometric primitives. ...

      Base class for a region-of-interest (ROI) bound by geometric primitives.

      So-called region-of-interest(s) (ROIs) are typically used to describe a
      region in space (and time) where an observation is made or for which
      a computer simulation is performed with given boundary conditions.

**Symbols**:

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

      The symbols used in the schema to specify e.g. dimensions of arrays.
      Use :ref:`NXcg_primitive` and :ref:`NXcoordinate_system` classes to
      define explicitly the reference frame in which the primitives are
      defined.

**Groups cited**:
  :ref:`NXcg_cylinder`, :ref:`NXcg_ellipsoid`, :ref:`NXcg_hexahedron`, :ref:`NXcg_parallelogram`, :ref:`NXcg_polyhedron`

.. index:: NXcg_ellipsoid (base class); used in base class, NXcg_cylinder (base class); used in base class, NXcg_parallelogram (base class); used in base class, NXcg_hexahedron (base class); used in base class, NXcg_polyhedron (base class); used in base class

**Structure**:

  .. _/NXcg_roi/CG_ELLIPSOID-group:

  :bolditalic:`CG_ELLIPSOID`: (optional) :ref:`NXcg_ellipsoid` 


  .. _/NXcg_roi/CG_CYLINDER-group:

  :bolditalic:`CG_CYLINDER`: (optional) :ref:`NXcg_cylinder` 


  .. _/NXcg_roi/CG_PARALLELOGRAM-group:

  :bolditalic:`CG_PARALLELOGRAM`: (optional) :ref:`NXcg_parallelogram` 


  .. _/NXcg_roi/CG_HEXAHEDRON-group:

  :bolditalic:`CG_HEXAHEDRON`: (optional) :ref:`NXcg_hexahedron` 


  .. _/NXcg_roi/CG_POLYHEDRON-group:

  :bolditalic:`CG_POLYHEDRON`: (optional) :ref:`NXcg_polyhedron` 



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

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


* :ref:`/NXcg_roi/CG_CYLINDER-group </NXcg_roi/CG_CYLINDER-group>`
* :ref:`/NXcg_roi/CG_ELLIPSOID-group </NXcg_roi/CG_ELLIPSOID-group>`
* :ref:`/NXcg_roi/CG_HEXAHEDRON-group </NXcg_roi/CG_HEXAHEDRON-group>`
* :ref:`/NXcg_roi/CG_PARALLELOGRAM-group </NXcg_roi/CG_PARALLELOGRAM-group>`
* :ref:`/NXcg_roi/CG_POLYHEDRON-group </NXcg_roi/CG_POLYHEDRON-group>`

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