Skip to content

Commit 02d36f0

Browse files
authored
Merge pull request #208 from marktsuchida/utilities-stage-state-device
Add Utilities StageStateDevice description
2 parents 82f8c9d + ede35c2 commit 02d36f0

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

_pages/Utilities.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ layout: page
2727
<td><p>Multi-Shutter, Multi-Camera<br />
2828
DA-Shutter, DA-Z-Stage, DA--XY-Stage<br />
2929
Autofocus-Stage<br />
30-
State-Device-Shutter</p></td>
30+
State-Device-Shutter<br />
31+
Stage-State-Device</p></td>
3132
</tr>
3233
</table>
3334

@@ -166,4 +167,37 @@ shutter. To use it you will need to set the "State Device Shutter"
166167
property to the desired state device. The state device should have a
167168
property that sets the "closed" position.
168169

169-
{% include Listserv_Search text="Utilities" %}
170+
## Stage-State-Device
171+
172+
Converts a (single-axis) stage device into a discrete state (switcher) device.
173+
For example, a linear stage that moves a mirror in and out, or a filter wheel
174+
controlled by a generic motion controller.
175+
176+
**Pre-initialization properties:**
177+
178+
- **NumberOfPositions** — the number of engaged positions (2–64).
179+
- **Position Mode** — choose `Equally Spaced` or `Individual` to determine
180+
how stage coordinates are specified.
181+
182+
**Setup:**
183+
184+
Set the `PhysicalStage` property to a loaded stage device.
185+
186+
In `Equally Spaced` mode, set `Position0(um)` (the coordinate for position 0)
187+
and `PositionSpacing(um)` (the distance between consecutive positions). In
188+
`Individual` mode, set `Position-0(um)`, `Position-1(um)`, etc. to specify the
189+
coordinate for each position independently.
190+
191+
All of these settings are best added to the `System`-`Startup` group preset.
192+
193+
**Disengaged position:**
194+
195+
In addition to the configured positions, there is an extra position labeled
196+
`Disengaged`. This is the initial state after initialization. While in the
197+
Disengaged position, no stage movement occurs, which prevents unintended moves
198+
during setup or before the stage has been homed.
199+
200+
Changing position settings (coordinates or spacing) while in an engaged
201+
position will immediately move the stage, which is convenient for finding the
202+
correct values. To adjust position settings without causing stage movements,
203+
first switch to the Disengaged position.

0 commit comments

Comments
 (0)