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

.. index::
    ! NXenvironment (base class)
    ! environment (base class)
    see: environment (base class); NXenvironment

.. _NXenvironment:

=============
NXenvironment
=============

..
    Contributors List

    .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15

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

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Parameters for controlling external conditions

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`, :ref:`NXnote`, :ref:`NXsensor`, :ref:`NXtransformations`

.. index:: NXgeometry (base class); used in base class, NXtransformations (base class); used in base class, NXnote (base class); used in base class, NXsensor (base class); used in base class

**Structure**:

  .. _/NXenvironment/name-field:

  .. index:: name (field)

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

    Apparatus identification code/model number; e.g. OC100 011

  .. _/NXenvironment/short_name-field:

  .. index:: short_name (field)

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

    Alternative short name, perhaps for dashboard display like a present Seblock name

  .. _/NXenvironment/type-field:

  .. index:: type (field)

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

    Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

  .. _/NXenvironment/description-field:

  .. index:: description (field)

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

    Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

  .. _/NXenvironment/program-field:

  .. index:: program (field)

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

    Program controlling the apparatus; e.g. LabView VI name

  .. _/NXenvironment/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: NeXus positions components by applying a set of translations and rotations ...

        NeXus positions components by applying a set of translations and rotations
        to apply to the component starting from 0, 0, 0. The order of these operations
        is critical and forms what NeXus calls a dependency chain. The depends_on
        field defines the path to the top most operation of the dependency chain or the
        string "." if located in the origin. Usually these operations are stored in a
        NXtransformations group. But NeXus allows them to be stored anywhere.

  .. _/NXenvironment/position-group:

  **position**: (optional) :ref:`NXgeometry` 

    .. collapse:: The position and orientation of the apparatus. ...

        The position and orientation of the apparatus.
        Note, it is recommended to use NXtransformations instead.

  .. _/NXenvironment/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` 

    .. collapse:: This is the group recommended for holding the chain of translation ...

        This is the group recommended for holding the chain of translation
        and rotation operations necessary to position the component within
        the instrument. The dependency chain may however traverse similar groups in
        other component groups.

  .. _/NXenvironment/NOTE-group:

  **NOTE**: (optional) :ref:`NXnote` 

    Additional information, LabView logs, digital photographs, etc

  .. _/NXenvironment/SENSOR-group:

  **SENSOR**: (optional) :ref:`NXsensor` 



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

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


* :ref:`/NXenvironment/depends_on-field </NXenvironment/depends_on-field>`
* :ref:`/NXenvironment/description-field </NXenvironment/description-field>`
* :ref:`/NXenvironment/name-field </NXenvironment/name-field>`
* :ref:`/NXenvironment/NOTE-group </NXenvironment/NOTE-group>`
* :ref:`/NXenvironment/position-group </NXenvironment/position-group>`
* :ref:`/NXenvironment/program-field </NXenvironment/program-field>`
* :ref:`/NXenvironment/SENSOR-group </NXenvironment/SENSOR-group>`
* :ref:`/NXenvironment/short_name-field </NXenvironment/short_name-field>`
* :ref:`/NXenvironment/TRANSFORMATIONS-group </NXenvironment/TRANSFORMATIONS-group>`
* :ref:`/NXenvironment/type-field </NXenvironment/type-field>`

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