MS2000 or RM2000 syntax

Shortcut	ZS
Format	ZS [X=dZ] [Y=num_slices] [Z=mode] [F=stack_timeout] [M=stack_state] [T?]
Remembered	Using SS Z

Tiger syntax

Shortcut	ZS
Format	[addr#]ZS [X=dZ] [Y=num_slices] [Z=mode] [F=stack_timeout] [M=stack_state] [T?]
Type	Card-Addressed
Remembered	Using [addr#]SS Z

Required Firmware Modules:

• IN0_INTERRUPT (need to use TTL X=4 for Z-stacks)

Incompatible Firmware Modules:

• TTL_REPORT_INT

Parameters:

X [dZ]: The amount to move each slice in 10ths of microns (ASI units).

Y [num_slices]: The number of slices in the Z-stack, the maximum value is 32767. Prior to MS2000 v9.50 and Tiger v3.43 the maximum number of slices is 127.

Z [mode]: Select between a sawtooth or triangle waveform for stage motion for repeated stacks. The default mode is the sawtooth waveform, i.e. repeating stacks always in the same direction.

F [stack_timeout]: The maximum amount of time in milliseconds between TTL input pulses. The stage will return to the starting position of the Z-stack after stack_timeout ms has elapsed without a TTL input trigger.

The default stack_timeout is 500, and the max value is 32767.

MS-2000 v9.55 or Tiger v3.53 required
T [stack_index]: Read the current stack_index with ZS T?, the index starts at 0 and goes up to num_slices-1.

MS-2000 v9.55 or Tiger v3.54 required
M [stack_state]: Read the current stack state as an integer. The Z-stack is active if the return code is not 0.

Sending ZS M=0 exits the Z-stack and returns to the initial position. This is the only valid state to send to ZS M=#.

Command Description:

This command sets parameters for use with TTL triggered Z movement. User must also set TTL X=4 for this trigger mode to be active. When a positive TTL edge is detected, the focus axis is moved by an amount dZ (expressed in 10ths of microns). Note that internally the amount dZ is actually stored as a multiple of the encoder unit, e.g. ~22 nanometers for a 4 TPI stage with rotary encoders, or 10 nanometers exactly for most linear encoded stages. This move distance is repeated for num_slices TTL triggered moves. If mode=1, the stage will step in the opposite direction for n moves, then turn around again, repeating a triangular waveform cycle. If mode=0 the stage will return to the original position after num_slices moves and repeat a saw-tooth waveform cycle.

The current position when the first TTL pulse is received becomes the center of the stack as well as the position that the stage returns to after the timeout duration.

The stack begins with a move to the negative extreme if dZ is positive and moves in increasing position. To reverse the polarity use a negative dZ.

Note that the total range traversed during the stack is dZ*(num_slices-1).

The axis moved by the TTL is the designated “focus index” (also the axis used for CRISP among other things). Use UNLOCK F to read or set the axis letter corresponding to “focus index”. Note the setting has to be changed, settings saved, and the controller reset or power cycled for the new setting to take effect. If the controller has a piezo but no motorized focus drive then the piezo axis should be set as the “focus index”. If both are present the “focus index” normally defaults to the piezo. Prior to Tiger v3.44 the ZS command would always move the z index rather than the focus index.

This is not the only way to perform a Z-stack using ASI hardware, the ring buffer module can be setup to do Z-stacks as well.

If there are no errors, a positive reply of :A will be returned. Example

Setup to do twenty 1 micron slices with triangular pattern.

Tiger Example

The focus drive axis is at card address 2

2ZS X=10 Y=20 Z=1
:A

MS2000 Example

ZS X=10 Y=20 Z=1
:A

Examples of expected behavior:

Graphs of the Z position data

The center of the Z-stack is 0 in the following graphs.

Sawtooth Waveform

Use an odd num_slices if you want the center point to be on the starting position.

An even num_slices is symmetrical around the starting position.

Triangle Waveform

The triangle waveform swaps starting positions every Z-stack.