Skip to content

Commit

Permalink
feat: add keep_shutter_open to MDAEvent (#107)
Browse files Browse the repository at this point in the history
* feat add keep_shutter_open

* feat: add keep shutter open
  • Loading branch information
tlambert03 authored Jul 24, 2023
1 parent f0dcb56 commit e50aa35
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/useq/_mda_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,12 @@ class MDAEvent(UseqModel):
The action to perform for this event. By default, [`useq.AcquireImage`][].
Example of another action is [`useq.HardwareAutofocus`][] which could be used
to perform a hardware autofocus.
keep_shutter_open : bool
If True, the illumination shutter should be left open after the event has
been executed, otherwise it should be closed. By default, `False`."
This is useful when the sequence of events being executed use the same
illumination scheme (such as a z-stack in a single channel), and closing and
opening the shutter between events would be slow.
"""

index: ReadOnlyDict[str, int] = Field(default_factory=ReadOnlyDict)
Expand All @@ -133,6 +139,7 @@ class MDAEvent(UseqModel):
properties: Optional[List[PropertyTuple]] = None
metadata: Dict[str, Any] = Field(default_factory=dict)
action: Action = Field(default_factory=AcquireImage)
keep_shutter_open: bool = False

# action
# keep shutter open between channels/steps
Expand Down

0 comments on commit e50aa35

Please sign in to comment.