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

.. index::
    ! NXcg_roi_set (base class)
    ! cg_roi_set (base class)
    see: cg_roi_set (base class); NXcg_roi_set

.. _NXcg_roi_set:

============
NXcg_roi_set
============

**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 the depends_on fields of the respective specialized
      :ref:`NXcg_primitive_set` base class surplus
      :ref:`NXcoordinate_system_set` with at least one instance of
      :ref:`NXcoordinate_system` to define explicitly the reference frame in
      which the primitives are defined.  Alternatively, although
      disencouraged, one may use one :ref:`NXcoordinate_system_set` with
      with only one :ref:`NXcoordinate_system` in the application definition
      to specify implicitly in which reference frame the primitives are
      defined.  If none of these two possibilities is used all primitives
      are assumed defined in the McStas coordinate system.

**Groups cited**:
  :ref:`NXcg_cylinder_set`, :ref:`NXcg_ellipsoid_set`, :ref:`NXcg_hexahedron_set`, :ref:`NXcg_parallelogram_set`, :ref:`NXcg_polyhedron_set`, :ref:`NXcg_sphere_set`

.. index:: NXcg_sphere_set (base class); used in base class, NXcg_ellipsoid_set (base class); used in base class, NXcg_cylinder_set (base class); used in base class, NXcg_parallelogram_set (base class); used in base class, NXcg_hexahedron_set (base class); used in base class, NXcg_polyhedron_set (base class); used in base class

**Structure**:

  .. _/NXcg_roi_set/CG_SPHERE_SET-group:

  **CG_SPHERE_SET**: (optional) :ref:`NXcg_sphere_set` 


  .. _/NXcg_roi_set/CG_ELLIPSOID_SET-group:

  **CG_ELLIPSOID_SET**: (optional) :ref:`NXcg_ellipsoid_set` 


  .. _/NXcg_roi_set/CG_CYLINDER_SET-group:

  **CG_CYLINDER_SET**: (optional) :ref:`NXcg_cylinder_set` 


  .. _/NXcg_roi_set/CG_PARALLELOGRAM_SET-group:

  **CG_PARALLELOGRAM_SET**: (optional) :ref:`NXcg_parallelogram_set` 


  .. _/NXcg_roi_set/CG_HEXAHEDRON_SET-group:

  **CG_HEXAHEDRON_SET**: (optional) :ref:`NXcg_hexahedron_set` 


  .. _/NXcg_roi_set/CG_POLYHEDRON_SET-group:

  **CG_POLYHEDRON_SET**: (optional) :ref:`NXcg_polyhedron_set` 



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

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


* :ref:`/NXcg_roi_set/CG_CYLINDER_SET-group </NXcg_roi_set/CG_CYLINDER_SET-group>`
* :ref:`/NXcg_roi_set/CG_ELLIPSOID_SET-group </NXcg_roi_set/CG_ELLIPSOID_SET-group>`
* :ref:`/NXcg_roi_set/CG_HEXAHEDRON_SET-group </NXcg_roi_set/CG_HEXAHEDRON_SET-group>`
* :ref:`/NXcg_roi_set/CG_PARALLELOGRAM_SET-group </NXcg_roi_set/CG_PARALLELOGRAM_SET-group>`
* :ref:`/NXcg_roi_set/CG_POLYHEDRON_SET-group </NXcg_roi_set/CG_POLYHEDRON_SET-group>`
* :ref:`/NXcg_roi_set/CG_SPHERE_SET-group </NXcg_roi_set/CG_SPHERE_SET-group>`

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