Skip to content

Commit 853d9d8

Browse files
committed
Add stage flip documentation
1 parent 9c718f3 commit 853d9d8

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/source/user_guide/software_configuration.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ specifies joystick-controlled axes.
127127
theta_offset: 0
128128
f_offset: 0
129129
130+
flip_x: False
131+
flip_y: False
132+
flip_z: False
133+
flip_f: False
134+
130135
131136
132137
First, we set the axes controlled by each piece of hardware and a mapping from the
@@ -140,12 +145,27 @@ that axes should be defined as a ``SyntheticStage``, as shown above for ``Theta`
140145
Below this, we specify that only ``X``, ``Y`` and ``Z`` axes may be controlled by a
141146
joystick and we set the stage bounds for each of the axes.
142147

143-
Finally, we set the offset for each stage axis. This is an offset relative to other
148+
Below this, we set the minimum and maximum values for each axis. This can be used to
149+
set boundaries that prevent the stage from crashing into the sides of a chamber.
150+
151+
Below this, we set the offset for each stage axis. This is an offset relative to other
144152
microscopes (e.g. ``microscope2``) specified in ``configuration.yaml``. In this case,
145153
``microscope1`` is the reference microscope. Additional microscopes may ask the stage
146154
to move to a different offset in order to observe the sample at the same position as
147155
``microscope1``.
148156

157+
Finally, we set the flip flags. These are important for getting
158+
:ref:`multiposition <user_guide/gui_walkthrough:multiposition>` acquisitions to
159+
run properly. We set a convention in the software to expect that increasing value along
160+
an axis brings the sample further into our field of view. That is, increasing the
161+
x-axis position should bring the sample further to the right in the frame (in the case
162+
:ref:`Flip XY <user_guide/gui_walkthrough:LUT>` is toggled on) and increasing the
163+
y-axis position should bring the sample down. Increasing the z-position should bring
164+
the sample closer to the objective. If the stage behaves the opposite of any of these
165+
ways, it is prudent to set the flip flag. If set properly, the calculations for moving
166+
through multiple positions will be performed correctly. These only need to be
167+
configured once when setting up the microscope.
168+
149169
-----------------
150170

151171
Stage Axes Definition

0 commit comments

Comments
 (0)