2.3.3.3.82. NXcoordinate_system

Status:

base class, extends NXobject

Description:

Base class to detail a coordinate system (CS). ...

Base class to detail a coordinate system (CS).

Whenever possible, an instance of NXcoordinate_system should be used as a member in an NXcoordinate_system_set and the name of the instance should be this alias. This may support a process whereby jargon when talking about coordinate systems and conventions may become cleaner for users because it is not evident for people outside a lab that terms like e.g. tip space or specimen space refer to the same coordinate system. This is an example of jargon used in e.g. the field of atom probe tomography.

Symbols:

No symbol table

Groups cited:

NXtransformations

Structure:

origin: (optional) NX_CHAR

Human-readable field telling where the origin of this CS is. ...

Human-readable field telling where the origin of this CS is. Exemplar values could be left corner of the lab bench, door-handle pinhole through which the electron beam exists the pole piece. barycenter of the triangle, center of mass of the stone.

alias: (optional) NX_CHAR

An alternative name given to that coordinate system.

type: (optional) NX_CHAR

Coordinate system type. ...

Coordinate system type.

Any of these values: undefined | cartesian

handedness: (optional) NX_CHAR

Handedness of the coordinate system if it is a Cartesian. ...

Handedness of the coordinate system if it is a Cartesian.

Any of these values: undefined | right_handed | left_handed

x_alias: (optional) NX_CHAR

Possibility to define an alias for the name of the x-axis.

x_direction: (optional) NX_CHAR

Human-readable field telling in which direction the x-axis points if that ...

Human-readable field telling in which direction the x-axis points if that instance of NXcoordinate_system has no reference to any parent and as such is the mighty world reference frame.

Exemplar values could be direction of gravity.

x: (optional) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH}

Base unit vector along the first axis which spans the coordinate system. ...

Base unit vector along the first axis which spans the coordinate system. This axis is frequently referred to as the x-axis in real space and the i-axis in reciprocal space.

y_alias: (optional) NX_CHAR

Possibility to define an alias for the name of the y-axis.

y_direction: (optional) NX_CHAR

Human-readable field telling in which direction the y-axis points if that ...

Human-readable field telling in which direction the y-axis points if that instance of NXcoordinate_system has no reference to any parent and as such is the mighty world reference frame.

See docstring of x_alias for further details.

y: (optional) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH}

Base unit vector along the second axis which spans the coordinate system. ...

Base unit vector along the second axis which spans the coordinate system. This axis is frequently referred to as the y-axis in real space and the j-axis in reciprocal space.

z_alias: (optional) NX_CHAR

Possibility to define an alias for the name of the z-axis.

z_direction: (optional) NX_CHAR

Human-readable field telling in which direction the z-axis points if that ...

Human-readable field telling in which direction the z-axis points if that instance of NXcoordinate_system has no reference to any parent and as such is the mighty world reference frame.

See docstring of x_alias for further details.

z: (optional) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH}

Base unit vector along the third axis which spans the coordinate system. ...

Base unit vector along the third axis which spans the coordinate system. This axis is frequently referred to as the z-axis in real space and the k-axis in reciprocal space.

depends_on: (optional) NX_CHAR

This specificies the relation to another coordinate system by pointing to the ...

This specificies the relation to another coordinate system by pointing to the last transformation in the transformation chain in the NXtransformations group.

TRANSFORMATIONS: (optional) NXtransformations

Collection of axis-based translations and rotations to describe this coordinat ...

Collection of axis-based translations and rotations to describe this coordinate system with respect to another coordinate system.

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