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

.. index::
    ! NXdetector_group (base class)
    ! detector_group (base class)
    see: detector_group (base class); NXdetector_group

.. _NXdetector_group:

================
NXdetector_group
================

..
    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:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Logical grouping of detectors. When used, describes a group of detectors. ...

      Logical grouping of detectors. When used, describes a group of detectors.

      Each detector is represented as an NXdetector 
      with its own detector data array.  Each detector data array
      may be further decomposed into array sections by use of
      NXdetector_module groups.  Detectors can be grouped logically
      together using NXdetector_group. Groups can be further grouped
      hierarchically in a single NXdetector_group (for example, if
      there are multiple detectors at an endstation or multiple 
      endstations at a facility).  Alternatively, multiple 
      NXdetector_groups can be provided.

      The groups are defined hierarchically, with names given
      in the group_names field, unique identifying indices given
      in the field group_index, and the level in the hierarchy
      given in the group_parent field.  For example if an x-ray
      detector group, DET, consists of four detectors in a
      rectangular array::

      		 DTL	DTR
      		 DLL	DLR

      We could have::

      	group_names: ["DET", "DTL", "DTR", "DLL", "DLR"]
       	group_index: [1, 2, 3, 4, 5]
       	group_parent:  [-1, 1, 1, 1, 1]

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXdetector_group@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.

  .. _/NXdetector_group/group_names-field:

  .. index:: group_names (field)

  **group_names**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: An array of the names of the detectors given in NXdetector ...

        An array of the names of the detectors given in NXdetector
        groups or the names of hierarchical groupings of detectors
        given as names of NXdetector_group groups or in
        NXdetector_group group_names and group_parent fields as
        having children.

  .. _/NXdetector_group/group_index-field:

  .. index:: group_index (field)

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

    .. collapse:: An array of unique identifiers for detectors or groupings  ...

        An array of unique identifiers for detectors or groupings 
        of detectors.

        Each ID is a unique ID for the corresponding detector or group
        named in the field group_names.  The IDs are positive integers
        starting with 1.

  .. _/NXdetector_group/group_parent-field:

  .. index:: group_parent (field)

  **group_parent**: (optional) :ref:`NX_INT <NX_INT>` (Rank: same as field group_index, Dimensions: same as field group_index) 

    .. collapse:: An array of the hierarchical levels of the parents of detectors ...

        An array of the hierarchical levels of the parents of detectors
        or groupings of detectors.

        A top-level grouping has parent level -1.

  .. _/NXdetector_group/group_type-field:

  .. index:: group_type (field)

  **group_type**: (optional) :ref:`NX_INT <NX_INT>` (Rank: same as field group_index, Dimensions: same as field group_index) 

    Code number for group type, e.g. bank=1, tube=2 etc.


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

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


* :ref:`/NXdetector_group/group_index-field </NXdetector_group/group_index-field>`
* :ref:`/NXdetector_group/group_names-field </NXdetector_group/group_names-field>`
* :ref:`/NXdetector_group/group_parent-field </NXdetector_group/group_parent-field>`
* :ref:`/NXdetector_group/group_type-field </NXdetector_group/group_type-field>`
* :ref:`/NXdetector_group@default-attribute </NXdetector_group@default-attribute>`

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