2.3.3.3.90. NXspm_scan_pattern¶
Status:
base class (contribution), extends NXobject
Description:
Basic base class to define the pattern of a scan in a given scan region. ...
Basic base class to define the pattern of a scan in a given scan region.
The base class is intended to handle the following scan types or patterns:
- Trajectory: A list of N-dimensional sequential vectors, representing a point in phase space, describes
the trajectory line for a full scan.
- Mesh: For each dimension, a range and a direction are chosen. When a scan along a dimension is done, a
single step in the next dimension is taken, and then the scan in the previous dimension is repeated. As such we can speak about the fastest and the slowest scan axes.
Snake: Similar to a mesh scan but the current scanning direction reversed after each line completed. Spiral: A scan taken along a spiral trajectory. Tilt: At each step, a proportional movement is done in all dimensions (an special case of Trajectory scan). Linear: A scan where the scanning will be performed along a single independent axis.
Symbols:
No symbol table
- Groups cited:
Structure:
scan_speedN: (optional) NX_NUMBER {units=NX_ANY}
Define the scan speed in the forward direction along the axis (except the spir ...
Define the scan speed in the forward direction along the axis (except the spiral and trajectory scans), if forward and backward speeds below are not specified.
If the scan goes in the negative direction, the speed should be negative.
Rename the field, according to the name of the dimension (e.g. scan_speed_x, scan_speed_voltage).
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
forward_speedN: (optional) NX_NUMBER {units=NX_ANY}
Define the scan speed in the forward directions (except the spiral and traject ...
Define the scan speed in the forward directions (except the spiral and trajectory scans). Rename the field, according to the name of the dimension.
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
backward_speedN: (optional) NX_NUMBER {units=NX_ANY}
Define the scan speed in the backward directions (except the spiral and trajec ...
Define the scan speed in the backward directions (except the spiral and trajectory scans). Rename the field, according to the name of the dimension.
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
channelNAME: (optional) NX_CHAR
Name of the channel that leads the scan data. The ending annotation 'NAME' is ...
Name of the channel that leads the scan data. The ending annotation ‘NAME’ is to represent the name of the channel and/or dimension.
Rename the field, according to the name of the channel and dimension (e.g. channel_piezo_scanner_x).
scan_pointsN: (optional) NX_NUMBER
Define the total number of points in the given axis the scan to be performed ( ...
Define the total number of points in the given axis the scan to be performed (except the spiral and trajectory scans). Rename the field, according to the name of the dimension (e.g. scan_points_x, scan_points_voltage).
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
steppingN: (optional) NX_NUMBER
The number of steps the probe jumps over the scan steps or points in the scann ...
The number of steps the probe jumps over the scan steps or points in the scanning process. This comes into picture, when not every point from the scan_points is scanned along an axis (except the spiral and trajectory scans).
Rename the field, according to the name of the dimension (e.g. stepping_x, stepping_voltage).
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
step_sizeN: (optional) NX_NUMBER {units=NX_ANY}
The size of each step in the scan on each dimension (except the spiral and tra ...
The size of each step in the scan on each dimension (except the spiral and trajectory scans).
Rename the field, according to the name of the dimension (e.g. step_size_x, step_size_voltage).
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
continuousN: (optional) NX_BOOLEAN
If the scan probe moves continuously over the scan points or steps, use True. ...
If the scan probe moves continuously over the scan points or steps, use True. The default value is True. Usually, continuous scanning is possible in one dimension. On other dimensions, the scan probe moves in steps.
Rename the field, according to the name of the dimension (e.g. continuous_voltage).
Trajectory scan: N refers to the nth trajectory line (line between two trajectory points). Spiral scan: N refers to the nth circle from center.
oscillating: (optional) NX_BOOLEAN
If the scan probe oscillates over the scan point, use True. ...
If the scan probe oscillates over the scan point, use True. The default value is False.
oscillation_frequency: (optional) NX_NUMBER
The number of oscillations on each scanning point per second.
number_of_trajectory_points: (optional) NX_NUMBER
The number of trajectory points in the entire scan that defines the path or li ...
The number of trajectory points in the entire scan that defines the path or lines of the trajectory. Each trajectory line is defined by two subsequent trajectory points.
trajectory_points: (optional) NX_NUMBER (Rank: 2, Dimensions: [nTraj, nD])
The trajectory points (nTraj) are the N-dimensional vectors (nD), each vector ...
The trajectory points (nTraj) are the N-dimensional vectors (nD), each vector refers to a point in N-dimensional phase space.
spiral_radiusN: (optional) NX_NUMBER {units=NX_ANY}
Define the radius of the spiral circle of scanning. ...
Define the radius of the spiral circle of scanning.
Rename the field, according to the circle order, the nearest circle to the center is 0.
The scan data is the data collected during the scan. ...
The scan data is the data collected during the scan. If the scan has several channels or derivatives from the channel data, please duplicate this NXdata group for each.
DATA: (optional) NX_NUMBER {units=NX_ANY} ⤆
The data (e.g. current, voltage, temperature) field that can be plotted agai ...
The data (e.g. current, voltage, temperature) field that can be plotted against the axes.
AXISNAME: (optional) NX_CHAR_OR_NUMBER {units=NX_ANY} ⤆
The name of the axis that corresponds to the data field.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
