2.3.3.3.91. NXspm_scan_region¶
Status:
base class (contribution), 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:
none
Structure:
scan_offset_valueN: (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.
‘N’ denotes the name of the specific scan axis. (Offset, start and end positions are related)
scan_rangeN: (optional) NX_NUMBER {units=NX_ANY}
The range of the scan is the difference start and end values of the scan regio ...
The range of the scan is the difference start and end values of the scan region along the dimension ‘N’.
scan_angleN: (optional) NX_NUMBER {units=NX_ANGLE}
The orientation of the scan region or subspace. Usually, the scan_offset and s ...
The orientation of the scan region or subspace. Usually, the scan_offset and scan_range are enough to define the scan region. This field defines how the spatial space is oriented with respect to the frame of reference.
Rename the field describing the angle with an axis of the spatial space (e.g. scan_angle_x).
scan_startN: (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_endN: (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.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
