2.3.3.1.13. NXcomponent

Status:

base class, extends NXobject

Description:

Base class for components of an instrument - real ones or simulated ones.

Symbols:

No symbol table

Groups cited:

NXfabrication, NXprogram, NXtransformations

Structure:

applied: (optional) NX_BOOLEAN

Was the component used?

name: (optional) NX_CHAR

Name of the component.

description: (optional) NX_CHAR

Ideally, use instances of ``identifierNAME`` to point to a resource ...

Ideally, use instances of identifierNAME to point to a resource that provides further details.

If such a resource does not exist or should not be used, use this free text, although it is not recommended.

inputs: (optional) NX_CHAR

Instance or list of instances of ``NXcomponent`` (or base classes ...

Instance or list of instances of NXcomponent (or base classes extending NXcomponent) or NXbeam that act as input(s) to this component.

Each input should point to the path of the group acting as input.

An example usage would be to chain components and/or beams together to describe the beam path in an experiment.

outputs: (optional) NX_CHAR

Instance or list of instances of ``NXcomponent`` (or base classes ...

Instance or list of instances of NXcomponent (or base classes extending NXcomponent) or NXbeam that act as output(s) of this component.

For more information, see inputs.

depends_on: (optional) NX_CHAR

Specifies the position of the component by pointing to the last ...

Specifies the position of the component by pointing to the last transformation in the transformation chain that is defined via the NXtransformations group.

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.

FABRICATION: (optional) NXfabrication

PROGRAM: (optional) NXprogram

TRANSFORMATIONS: (optional) NXtransformations

Collection of axis-based translations and rotations to describe the ...

Collection of axis-based translations and rotations to describe the location and geometry of the component in the instrument. The dependency chain may however traverse similar groups in other component groups.

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/NXcomponent.nxdl.xml