2.3.3.1.24. NXgeometry

Status:

base class, extends NXobject

DEPRECATED: as decided at 2014 NIAC meeting, convert to use NXtransformations

Description:

legacy class - recommend to use :ref:`NXtransformations` now ...

legacy class - recommend to use NXtransformations now

It is recommended that instances of NXgeometry be converted to use NXtransformations.

This is the description for a general position of a component. It is recommended to name an instance of NXgeometry as “geometry” to aid in the use of the definition in simulation codes such as McStas. Also, in HDF, linked items must share the same name. However, it might not be possible or practical in all situations.

Symbols:

No symbol table

Groups cited:

NXorientation, NXshape, NXtranslation

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.

description: (optional) NX_CHAR

Optional description/label. Probably only present if we are ...

Optional description/label. Probably only present if we are an additional reference point for components rather than the location of a real component.

component_index: (optional) NX_INT

Position of the component along the beam path. The sample is at 0, components ...

Position of the component along the beam path. The sample is at 0, components upstream have negative component_index, components downstream have positive component_index.

SHAPE: (optional) NXshape

shape/size information of component

TRANSLATION: (optional) NXtranslation

translation of component

ORIENTATION: (optional) NXorientation

orientation of component

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