useq.pycromanager ¶

Convert useq objects to the event dicts used by Pycro-Manager.

Classes

Name	Description
`PycroManagerAxes`	Axes dict used by pycro-manager.
`PycroManagerEvent`	Dict in the format expected by pycro-manager.

Functions

Name	Description
`to_pycromanager`	Convert a `useq.MDAEvent` or `useq.MDASequence` to pycro-manager form.

Attributes

Name	Description
`PycroAxis`
`PycroKey`

Classes¶

Bases: TypedDict

Axes dict used by pycro-manager.

Returned by:

time: int

position: int

z: int

channel: str

row: int

column: int

Bases: TypedDict

Dict in the format expected by pycro-manager.

Returned by:

axes: Required[PycroManagerAxes]

x: float

y: float

z: float

min_start_time: float

config_group: list[str]

exposure: float

properties: list[list[str]]

keep_shutter_open: bool

to_pycromanager(obj: MDAEvent) -> PycroManagerEvent

to_pycromanager(obj: MDASequence) -> list[PycroManagerEvent]

to_pycromanager(
    obj: MDAEvent | MDASequence,
) -> PycroManagerEvent | list[PycroManagerEvent]

Convert a useq.MDAEvent or useq.MDASequence to pycro-manager form.

Parameters:

Name	Type	Description	Default
`obj`	`MDAEvent \| MDASequence`	The event or sequence to convert.	required

Returns:

Type	Description
`PycroManagerEvent \| list[PycroManagerEvent]`	If `obj` is an `useq.MDAEvent`, returns a single pycro-manager event dict. Otherwise, returns a list of pycro-manager event dicts.

PycroAxis = Literal['time', 'position', 'z', 'channel', 'row', 'column']

PycroKey = Literal[
    "x", "y", "z", "exposure", "min_start_time", "keep_shutter_open"
]