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

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

  Base class to hold geometric primitives.

**Symbols**:

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

**Groups cited**:
  :ref:`NXcg_cylinder_set`, :ref:`NXcg_ellipsoid_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_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_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_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/nexusformat/definitions/blob/main/base_classes/NXcg_roi_set.nxdl.xml