2.3.3.3.89. NXspm_scan_control

Status:

base class (contribution), extends NXobject

Description:

A scan is performed inside an N-dimensional phase space, where each dimension ca ...

A scan is performed inside an N-dimensional phase space, where each dimension can correspond not only to real space coordinates (x,y) but also to any other parameter. This class contains detailed information about controlling the scan in such a phase space (or its subspace).

scan_types: Trajectory: A list of N-dimensional sequential vectors 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 with the scanning direction reversed after each line. Spiral: A scan taken along a spiral trajectory. Linear: A scan where the scanning will be performed along a single independent axis. Tilt: At each step, a proportional movement is done in all dimensions (an special case of Trajectory scan).

Scan_control_types: Stepping: At each step, a movement to the next point is performed; correction (for example backlash) or active regulation (feedback loop) may or may not be applied. After the movement is done, the measurement is performed without the movement. Continuous: The scanning of each line in an N-dimensional phase space is done without stopping; measurements are done simultaneously with the movement. Oscillating: Scanning over a scan point continuously and then moving to start scanning at the next position.

Symbols:

No symbol table

Groups cited:

NXspm_scan_pattern, NXspm_scan_region

Structure:

scan_time_start: (optional) NX_DATE_TIME {units=NX_TIME}

The start time of the scan.

scan_time_end: (optional) NX_DATE_TIME {units=NX_TIME}

The end time of the scan.

independent_scan_axes: (optional) NX_CHAR

An array of scan axes which are controlled independently of each other. ...

An array of scan axes which are controlled independently of each other. (e.g. X, Y, Z, or other physical dimensions)

The array elements are in the order of axes of the scan from the fastest to the slowest.

scan_resolutionN: (optional) NX_NUMBER {units=NX_ANY}

Define the scan resolution along each dimension as the number of steps per uni ...

Define the scan resolution along each dimension as the number of steps per unit of the dimension parameters.

Rename the field according to the name of the independent dimension (e.g. scan_resolution_x, scan_resolution_voltage).

accuracyN: (optional) NX_NUMBER {units=NX_LENGTH}

Define the accuracy of the scan probe.

scan_type: (optional) NX_CHAR

This group specifies how the trajectory of the scan is defined. ...

This group specifies how the trajectory of the scan is defined.

Any of these values:

  • trajectory

  • mesh

  • snake

  • spiral

  • linear

  • tilt

scan_control_type: (optional) NX_CHAR

This string describes how the scan was performed. ...

This string describes how the scan was performed.

Any of these values: stepping | continuous | oscillating

scan_region: (optional) NXspm_scan_region

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

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.

meshSCAN: (optional) NXspm_scan_pattern

For each dimension a range and a direction are chosen. When a scan along a dim ...

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.

spiralSCAN: (optional) NXspm_scan_pattern

To define the spiral or circular scan, use this group.

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.

scan_pointsN: (optional) NX_NUMBER ⤆

Define the total number of points in a given circle scan to be performed. ...

Define the total number of points in a given circle scan to be performed.

Rename the field, according to the circle order, the nearest circle to the center is 0 (e.g. scan_points_2).

snakeSCAN: (optional) NXspm_scan_pattern

To define the snake scan, use this group.

trajSCAN: (optional) NXspm_scan_pattern

To define the trajectory scan, use this group.

linearSCAN: (optional) NXspm_scan_pattern

To define the linear scan, use this group.

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