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

.. index::
    ! NXoff_geometry (base class)
    ! off_geometry (base class)
    see: off_geometry (base class); NXoff_geometry

.. _NXoff_geometry:

==============
NXoff_geometry
==============

..
    Contributors List

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

    .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Geometry (shape) description. ...

      Geometry (shape) description.
      The format closely matches the Object File Format (OFF) which can be output
      by most CAD software.
      It can be used to describe the shape of any beamline component, including detectors.
      In the case of detectors it can be used to define the shape of a single pixel, or,
      if the pixel shapes are non-uniform, to describe the shape of the whole detector.

**Symbols**:

  These symbols will be used below.

  **i**: number of vertices in the shape

  **k**: number of faces in the shape

  **l**: number faces which are detecting surfaces or form the boundary of detecting volumes

**Groups cited**:
  none

**Structure**:

  .. _/NXoff_geometry@default-attribute:

  .. index:: default (file attribute)

  **@default**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Declares which child group contains a path leading  ...

        .. index:: plotting

        Declares which child group contains a path leading 
        to a :ref:`NXdata` group.

        It is recommended (as of NIAC2014) to use this attribute
        to help define the path to the default dataset to be plotted.
        See https://www.nexusformat.org/2014_How_to_find_default_data.html
        for a summary of the discussion.

  .. _/NXoff_geometry/vertices-field:

  .. index:: vertices (field)

  **vertices**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [i, 3]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: List of x,y,z coordinates for vertices. ...

        List of x,y,z coordinates for vertices.
        The origin of the coordinates is the position of the parent component, for
        example the NXdetector which the geometry describes.
        If the shape describes a single pixel for a detector with uniform pixel
        shape then the origin is the position of each pixel as described by the
        ``x/y/z_pixel_offset`` datasets in ``NXdetector``.

  .. _/NXoff_geometry/winding_order-field:

  .. index:: winding_order (field)

  **winding_order**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [j]) 

    .. collapse:: List of indices of vertices in the ``vertices`` dataset to form each face, ...

        List of indices of vertices in the ``vertices`` dataset to form each face,
        right-hand rule for face normal.

  .. _/NXoff_geometry/faces-field:

  .. index:: faces (field)

  **faces**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [k]) 

    The start index in ``winding_order`` for each face.

  .. _/NXoff_geometry/detector_faces-field:

  .. index:: detector_faces (field)

  **detector_faces**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 2, Dimensions: [l, 2]) 

    .. collapse:: List of pairs of index in the "faces" dataset and detector id. Face IDs in ...

        List of pairs of index in the "faces" dataset and detector id. Face IDs in
        the first column, and corresponding detector IDs in the second column.
        This dataset should only be used only if the ``NXoff_geometry`` group is
        describing a detector.
        Note, the face indices must be in ascending order but need not be
        consecutive as not every face in faces need be a detecting surface or
        boundary of detecting volume.
        Can use multiple entries with the same detector id to define detector volumes.


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

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


* :ref:`/NXoff_geometry/detector_faces-field </NXoff_geometry/detector_faces-field>`
* :ref:`/NXoff_geometry/faces-field </NXoff_geometry/faces-field>`
* :ref:`/NXoff_geometry/vertices-field </NXoff_geometry/vertices-field>`
* :ref:`/NXoff_geometry/winding_order-field </NXoff_geometry/winding_order-field>`
* :ref:`/NXoff_geometry@default-attribute </NXoff_geometry@default-attribute>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXoff_geometry.nxdl.xml