2.3.3.1.18. NXenvironment

Status:

base class, extends NXobject

Description:

Parameters for controlling external conditions

Symbols:

No symbol table

Groups cited:

NXactuator, NXgeometry, NXnote, NXsensor, NXtransformations

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading ...

Declares which child group contains a path leading to a 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.

name: (optional) NX_CHAR

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

short_name: (optional) NX_CHAR

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

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

type: (optional) NX_CHAR

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

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

description: (optional) NX_CHAR

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

program: (optional) NX_CHAR

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

value: (optional) NX_FLOAT {units=NX_ANY}

This is to be used if there is no actuator/sensor that controls/measures ...

This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated.

Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.

depends_on: (optional) NX_CHAR

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.

position: (optional) NXgeometry

The position and orientation of the apparatus. ...

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

TRANSFORMATIONS: (optional) NXtransformations

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.

NOTE: (optional) NXnote

Additional information, LabView logs, digital photographs, etc

ACTUATOR: (optional) NXactuator

Any actuator used to control the environment. This can be linked to an actuato ...

Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.

SENSOR: (optional) NXsensor

Any sensor used to monitor the environment. This can be linked to a sensor ...

Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.

Hypertext Anchors

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

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXenvironment.nxdl.xml