Command:SCAN (SN)
- MS2000 or RM2000 syntax and Function
-
Shortcut SN Format SCAN [X=scan_axis for X] [Y=scan_axis for Y] [Z=scan_axis for Z] [F=pattern] Units Integer Remembered Using SS Z Firmware Required SCAN or ARRAY Sets which axes are to be used for 2-D raster scan. The same axis settings also apply to the
ARRAY
module. The fast-scanned raster axis (horizontal) is defined byscan_axis = 1
; the slow-scanned axis (vertical) is defined byscan_axis = 2
. Single axis scans (1-D) requires setting the unused axesscan_axis = 0
, and the driven axis asscan_axis = 1
. Note this is different from the Tiger meaning of pseudoaxes X/Y/Z.The scan pattern may be set to 0 for
RASTER
scans or 1 forSERPENTINE
scans. This setting defaults toRASTER
for firmwares with theSCAN MODULE
included andSERPENTINE
for firmwares with theARRAY MODULE
included. When the number of lines (SCANV Z
) is set to the default of 1 then the behavior is the same for both raster and serpentine.Without arguments, the command
SCAN
initiates (or stops) a scan using parameters set with theSCANR
andSCANV
commands.
- Tiger (motorized) syntax
-
Shortcut SN Format [addr#]SCAN [X?] [Y=fast_axis_id] [Z=slow_axis_id] [F=pattern] Units Integer Type Card-Addressed Remembered Using [addr#]SS Z Firmware Required SCAN or ARRAY Note multiple small changes in usage from MS-2000 command set.
Specifying an argument for the pseudoaxis X in decimal sets the state directly (see table below; the value is simply the decimal representation of the corresponding state character). Note that the firmware expects only certain states to be set by the user (marked as “OK to set” in the table); setting to a different state may yield unpredictable results. Querying the pseudoaxis X value returns the character associated with the current state.
Specify the cards axis ID as the
fast_axis_id
orslow_axis_id
(axis IDs are obtainable usingZ2B
query; they are 0 and 1 for X and Y axes respectively on a two-axis motor card). Ifslow_axis_id
is set to 9 then a true single-axis scan will be executed (not even anti-backlash moves on the slow axis); ifslow_axis_id
is specified but the slow axis start and stop positions (NV X
andNV Y
) are equal then a single-axis scan will execute but the slow axis position will be checked at the scan turnaround points.The scan pattern may be set to 0 for
RASTER
scans or 1 forSERPENTINE
scans.Without arguments, the command
SCAN
initiates (or stops) a scan using parameters set with theSCANR
andSCANV
commands.Scan states (SCAN_MODULE firmware) Char Dec OK to set? State I No Idle/disabled S 83 Yes Starts state machine P 80 Yes Stop (goes to idle state after cleanup) a No Waits until slow axis move complete b No Starts move along fast axis c No Waits for fast axis move to finish d No Starts serpentine slow axis move e No Waits until serepentine move complete f No Used in XF_SPIM only g No Waits until retrace is complete h No Scan complete, cleans up
- Tiger (micro-mirror) syntax
-
Shortcut SN Format [addr#]SCAN [X=state] Units Integer Type Card-Addressed Remembered Using [addr#]SS Z Firmware Required MM_SPIM Without arguments, starts or arms the SPIM state machine or terminates it if running or armed (starts state machine execution for Micro-mirror, puts in arm state for piezo). By so doing, any active single-axis functions will be stopped and the SPIM positions/steps will be calculated according to the active parameters (e.g. SAA, SAO, NR, NV, RT). Specifying an argument for the pseudo-axis X in decimal sets the state directly (see table below; the value is simply the decimal representation of the corresponding state character). Note that the firmware expects only certain states to be set by the user (marked as “OK to set” in the table); setting to a different state may yield unpredictable results. Querying the pseudo-axis X value returns the character associated with the current state.
Micro-mirror SPIM states (MM_SPIM firmware) Char Dec OK to set? State I No Idle/disabled S 83 Yes Starts main acquisition state machine a 97 Yes Arm for trigger (goes to state 'A') A No Armed and waiting T 84 Yes Trigger from state 'A' (v3.37+) P 80 Yes Stop (goes to state 'I') M No In middle of sheet (executing per-sheet scan/camera/laser state machines) s No Starting sheet c No Incrementing sheet R No Starting side y No Delay between sides Y No Delay between repeats Note: Other undocumented states may be used during SPIM state machine execution.