3.3.1.164. NXspm_scan_region

Status:

base class, extends NXobject

Description:

The scan region is the area of phase space or sub-phase space where the scan is …

The scan region is the area of phase space or sub-phase space where the scan is performed. The region could be N-dimensional and is defined by the minimum and maximum values of the scan axes.

Symbols:

No symbol table

Groups cited:

NXtransformations

Structure:

scan_offset_valueAXIS: (optional) NX_NUMBER {units=NX_ANY}

The offset of center of the scan region from the origin along the specific sca …

The offset of center of the scan region from the origin along the specific scan axis.

AXIS is the name of an independent scan axis (e.g. scan_offset_value_x, scan_offset_value_voltage). (Offset, start and end positions are related.)

scan_rangeAXIS: (optional) NX_NUMBER {units=NX_ANY}

The range of the scan is the difference between the start and end values of th …

The range of the scan is the difference between the start and end values of the scan region along the scan axis.

AXIS is the name of an independent scan axis (e.g. scan_range_x, scan_range_voltage).

scan_angleAXIS: (optional) NX_NUMBER {units=NX_ANGLE}

The in-plane orientation of the scan region: the angle of the fast scan axis f …

The in-plane orientation of the scan region: the angle of the fast scan axis from the x axis of the scanner frame, as a rotation about z through the centre of the scan region. Positive angles follow the right-hand rule, i.e. they are counter-clockwise when viewed from the probe side looking down onto the sample surface.

AXIS denotes a lateral scan axis (e.g. scan_angle_x). Both lateral scan axes are rotated by the same angle, so all instances must have the same value, and scan_angle_x alone is sufficient.

scan_startAXIS: (optional) NX_NUMBER {units=NX_ANY}

The start of the scan is the starting point of the scan region (phase space or …

The start of the scan is the starting point of the scan region (phase space or sub-phase space) for each independent scan axis.

For N-dimensional, it is a list of N numbers.

scan_endAXIS: (optional) NX_NUMBER {units=NX_ANY}

The end of the scan is the ending point of the scan region (phase space or sub …

The end of the scan is the ending point of the scan region (phase space or sub-phase space) for each independent scan axis.

Note: The scan_offset and scan_range are equivalent to the scan_start and scan_end.

For N-dimensional, it is a list of N numbers.

depends_on: (optional) NX_CHAR

Places the scan frame (origin at the centre of the scan region, x along th …

Places the scan frame (origin at the centre of the scan region, x along the fast scan axis, y along the slow scan axis) in the frame in which the scan offsets and the scan angle are given. Points to the transformation in transformations that is applied first to a position in the scan frame.

transformations: (optional) NXtransformations

Translations and rotations that place the scan frame in its parent frame, typi …

Translations and rotations that place the scan frame in its parent frame, typically the scan offset along each axis followed by the scan angle about z.

Hypertext Anchors

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

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/base_classes/NXspm_scan_region.nxdl.xml