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

.. index::
    ! NXcg_ellipsoid (base class)
    ! cg_ellipsoid (base class)
    see: cg_ellipsoid (base class); NXcg_ellipsoid

.. _NXcg_ellipsoid:

==============
NXcg_ellipsoid
==============

**Status**:

  base class, extends :ref:`NXcg_primitive`

**Description**:

  Computational geometry description of a set of ellipsoids.

**Symbols**:

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

  **d**: The dimensionality of the space in which the members are assumed embedded.

  **c**: The cardinality of the set, i.e. the number of members.

**Groups cited**:
  none

**Structure**:

  .. _/NXcg_ellipsoid/semi_axes_value-field:

  .. index:: semi_axes_value (field)

  **semi_axes_value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [d]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: Length of the semi-axes (e.g. semi-major and semi-minor ...

        Length of the semi-axes (e.g. semi-major and semi-minor
        respectively for an ellipse).

        Use if all ellipsoids in the set have the same half-axes.

  .. _/NXcg_ellipsoid/semi_axes_values-field:

  .. index:: semi_axes_values (field)

  **semi_axes_values**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [c, d]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Length of the semi-axes if ellipsoids have individually different lengths.

  .. _/NXcg_ellipsoid/radius-field:

  .. index:: radius (field)

  **radius**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    In the case that all ellipsoids are spheres.

  .. _/NXcg_ellipsoid/radii-field:

  .. index:: radii (field)

  **radii**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [c]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: In the case that all ellipsoids are spheres whose radii differ. ...

        In the case that all ellipsoids are spheres whose radii differ.
        For a mixture of spheres use semi_axes_values.


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

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


* :ref:`/NXcg_ellipsoid/radii-field </NXcg_ellipsoid/radii-field>`
* :ref:`/NXcg_ellipsoid/radius-field </NXcg_ellipsoid/radius-field>`
* :ref:`/NXcg_ellipsoid/semi_axes_value-field </NXcg_ellipsoid/semi_axes_value-field>`
* :ref:`/NXcg_ellipsoid/semi_axes_values-field </NXcg_ellipsoid/semi_axes_values-field>`

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