pymmcore_widgets.useq_widgets ¶

Widgets for the useq-schema data model.

Submodules

Name	Description
`points_plans`	Widgets that create MultiPoint plans.

Classes

Name	Description
`BoolColumn`	Column of checkboxes (`bool` values).
`ChoiceColumn`	Column of combo boxes, choosing from `allowed_values`.
`DataTable`	Table whose columns are defined by `ColumnInfo` class attributes.
`DataTableWidget`	A `DataTable` with a toolbar to add, select and remove rows.
`FloatColumn`	Column of float spin boxes, between `minimum` and `maximum`.
`IntColumn`	Column of integer spin boxes, between `minimum` and `maximum`.
`PointsPlanWidget`	Widget to select the FOVs per well of the plate.
`TextColumn`	Column that will use a standard QTableWidgetItem.
`TimeDeltaColumn`	Column of durations, typed as text with units (e.g. `"1.5 s"`, `"2 min"`).
`WellPlateWidget`	Widget for selecting a well plate and a subset of wells.

Attributes

Name	Description
`PYMMCW_METADATA_KEY`

Classes¶

BoolColumn `dataclass` ¶

BoolColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: Any = None,
    default_factory: Callable[[], Any] | None = None,
    data_type: WdgGetSet = TableBoolWidget,
)

Bases: WidgetColumn

Column of checkboxes (bool values).

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`WdgGetSet`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`Any`
`default_factory`	`Callable[[], Any] \| None`

Used by:

API Reference pymmcore-widgets pymmcore_widgets ChannelTable API DO_STACK

data_type ¶

data_type: WdgGetSet = TableBoolWidget

ChoiceColumn `dataclass` ¶

ChoiceColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: Any = None,
    default_factory: Callable[[], Any] | None = None,
    data_type: WdgGetSet[CheckableCombo, str] = ChoiceWidget,
    allowed_values: tuple[str, ...] | None = None,
)

Bases: WidgetColumn

Column of combo boxes, choosing from allowed_values.

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`WdgGetSet[CheckableCombo, str]`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`Any`
`default_factory`	`Callable[[], Any] \| None`
`allowed_values`	`tuple[str, ...] \| None`

data_type ¶

data_type: WdgGetSet[CheckableCombo, str] = ChoiceWidget

allowed_values ¶

allowed_values: tuple[str, ...] | None = None

isChecked ¶

isChecked(table: QTableWidget, row: int, col: int) -> bool

setCheckState ¶

setCheckState(
    table: QTableWidget, row: int, col: int, state: CheckState
) -> None

FloatColumn `dataclass` ¶

FloatColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: Any = None,
    default_factory: Callable[[], Any] | None = None,
    minimum: float = 0,
    maximum: float = 999999,
    decimals: int = 2,
    data_type: WdgGetSet = TableFloatWidget,
)

Column of float spin boxes, between minimum and maximum.

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`WdgGetSet`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`Any`
`default_factory`	`Callable[[], Any] \| None`
`minimum`	`float`
`maximum`	`float`
`decimals`	`int`

Used by:

API Reference pymmcore-widgets pymmcore_widgets
- ChannelTable API
  - EXPOSURE
  - Z_OFFSET
- PositionTable API
  - AF
  - X
  - Y
  - Z

data_type ¶

data_type: WdgGetSet = TableFloatWidget

IntColumn `dataclass` ¶

IntColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: Any = None,
    default_factory: Callable[[], Any] | None = None,
    minimum: int = 0,
    maximum: int = 999999999,
    decimals: int = 2,
    data_type: WdgGetSet = TableIntWidget,
)

Column of integer spin boxes, between minimum and maximum.

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`WdgGetSet`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`Any`
`default_factory`	`Callable[[], Any] \| None`
`minimum`	`int`
`maximum`	`int`
`decimals`	`int`

Used by:

API Reference pymmcore-widgets pymmcore_widgets
- ChannelTable API ACQUIRE_EVERY
- TimePlanWidget API LOOPS

data_type ¶

data_type: WdgGetSet = TableIntWidget

minimum ¶

minimum: int = 0

maximum ¶

maximum: int = 999999999

TextColumn `dataclass` ¶

TextColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: str | None = None,
    default_factory: Callable[[], Any] | None = None,
    data_type: type = str,
    checkable: bool = False,
    checked: bool = True,
)

Bases: ColumnInfo

Column that will use a standard QTableWidgetItem.

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`type`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`str \| None`
`default_factory`	`Callable[[], Any] \| None`
`checkable`	`bool`
`checked`	`bool`

Used by:

API Reference pymmcore-widgets pymmcore_widgets
- ChannelTable API
  - CONFIG
  - GROUP
- PositionTable API NAME
- TimePlanWidget API PHASE

data_type ¶

data_type: type = str

header ¶

header: str | None = None

is_row_selector ¶

is_row_selector: bool = False

hidden ¶

hidden: bool = False

default ¶

default: str | None = None

checkable ¶

checkable: bool = False

checked ¶

checked: bool = True

init_cell ¶

init_cell(
    table: QTableWidget, row: int, col: int, change_signal: SignalInstance
) -> None

get_cell_data ¶

get_cell_data(table: QTableWidget, row: int, col: int) -> dict[str, Any]

set_cell_data ¶

set_cell_data(table: QTableWidget, row: int, col: int, value: Any) -> None

isChecked ¶

isChecked(table: QTableWidget, row: int, col: int) -> bool

setCheckState ¶

setCheckState(
    table: QTableWidget, row: int, col: int, state: CheckState
) -> None

TimeDeltaColumn `dataclass` ¶

TimeDeltaColumn(
    _ROLE: int = UserRole + 1,
    header: str | None = None,
    is_row_selector: bool = False,
    hidden: bool = False,
    default: Any = None,
    default_factory: Callable[[], Any] | None = None,
    data_type: WdgGetSet[QTimeLineEdit, float] = TableTimeWidget,
    minimum_unit: Unit = "seconds",
)

Bases: WidgetColumn

Column of durations, typed as text with units (e.g. "1.5 s", "2 min").

Attributes:

Name	Type	Description
`key`	`str`
`data_type`	`WdgGetSet[QTimeLineEdit, float]`
`header`	`str \| None`
`is_row_selector`	`bool`
`hidden`	`bool`
`default`	`Any`
`default_factory`	`Callable[[], Any] \| None`
`minimum_unit`	`Unit`

Used by:

API Reference pymmcore-widgets pymmcore_widgets TimePlanWidget API
- DURATION
- INTERVAL

data_type ¶

data_type: WdgGetSet[QTimeLineEdit, float] = TableTimeWidget

minimum_unit ¶

minimum_unit: Unit = 'seconds'

DataTable ¶

DataTable(rows: int = 0, parent: QWidget | None = None)

Bases: QTableWidget

Table whose columns are defined by ColumnInfo class attributes.

Returned by:

API Reference pymmcore-widgets pymmcore_widgets

valueChanged ¶

valueChanged = Signal()

COLUMNS ¶

COLUMNS: tuple[ColumnInfo, ...] = ()

columnInfo ¶

columnInfo(col: int) -> ColumnInfo | None

addColumns ¶

addColumns(column_info: Iterable[ColumnInfo]) -> None

addColumn ¶

addColumn(column_info: ColumnInfo, position: int | None = None) -> None

Add a new column to the table.

The ColumnInfo object is stored in the header item's data and used to populate the new column, and new rows that are added later, based on the data type and other info in the ColumnInfo object.

indexOf ¶

indexOf(header: str | ColumnInfo) -> int

iterRecords ¶

iterRecords(
    exclude_unchecked: bool = False, exclude_hidden_cols: bool = False
) -> Iterator[Record]

Return an iterator over the data in the table in records format.

(Records are a list of dicts mapping {'column header' -> value} for each row.)

setValue ¶

setValue(records: Iterable[Record]) -> None

Set the value of the table.

checkAllRows ¶

checkAllRows() -> None

clearChecks ¶

clearChecks() -> None

rowData ¶

rowData(row: int, exclude_hidden_cols: bool = False) -> Record

setRowData ¶

setRowData(row: int, data: Record) -> None

DataTableWidget ¶

DataTableWidget(rows: int = 0, parent: QWidget | None = None)

Bases: QWidget

A DataTable with a toolbar to add, select and remove rows.

Base class of ChannelTable, PositionTable and TimePlanWidget.

Subclassed by:

API Reference pymmcore-widgets pymmcore_widgets

valueChanged ¶

valueChanged = Signal()

Emitted (with no arguments) when the table changes; read it with value().

COLUMNS ¶

COLUMNS: tuple[ColumnInfo, ...]

table ¶

table() -> DataTable

toolBar ¶

toolBar() -> QToolBar

value ¶

value(exclude_unchecked: bool = True) -> Any

Return a list of dicts of the data in the table.

setValue ¶

setValue(value: Iterable[Any]) -> None

Set the value of the table.

WellPlateWidget ¶

WellPlateWidget(
    plan: WellPlatePlan | WellPlate | None = None, parent: QWidget | None = None
)

Bases: QWidget

Widget for selecting a well plate and a subset of wells.

The value returned/received by this widget is a useq.WellPlatePlan (or simply a useq.WellPlate if no selection is made). This widget draws the well plate and allows the user to select wells by clicking/dragging on them.

Parameters:

Name	Type	Description	Default
`plan`	`WellPlatePlan \| WellPlate \| None`	The initial well plate plan. Accepts both a useq.WellPlate (which lacks a selection definition), or a full WellPlatePlan. By default None.	`None`
`parent`	`QWidget`	The parent widget, by default None	`None`

Referenced by:

API Reference pymmcore-widgets API reference

valueChanged ¶

valueChanged = Signal(object)

Emitted with the new useq.WellPlatePlan when the plate or selection changes.

setShowRotation ¶

setShowRotation(allow: bool) -> None

Set whether to allow visible rotation of the well plate.

If allow is False, the rotation checkbox is hidden and the rotation is never shown. If True, the checkbox is shown and the user can toggle the rotation on/off.

value ¶

value() -> WellPlatePlan

Return the current plate and the selected wells as a useq.WellPlatePlan.

setValue ¶

setValue(value: WellPlatePlan | WellPlate | Mapping) -> None

Set the current plate and the selected wells.

Parameters:

Name	Type	Description	Default
`value`	`PlateInfo`	The plate information to set containing the plate and the selected wells as a list of (name, row, column).	required

currentSelection ¶

currentSelection() -> tuple[tuple[int, int], ...]

Return the indices of the selected wells as ((row, col), ...).

setCurrentSelection ¶

setCurrentSelection(selection: IndexExpression) -> None

Select the wells with the given indices.

selection can be any 2-d numpy indexing expression, e.g.: - (0, 0) - [(0, 0), (1, 1), (2, 2)] - slice(0, 2) - (0, slice(0, 2))

PointsPlanWidget ¶

PointsPlanWidget(
    plan: RelativeMultiPointPlan | None = None, parent: QWidget | None = None
)

Bases: QWidget

Widget to select the FOVs per well of the plate.

This widget allows the user to select the number of FOVs per well, (or to generally show a multi-point plan, such as a grid or random points plan, even if not within the context of a well plate.)

The value() method returns the selected plan, one of: - useq.GridRowsColumns - useq.RandomPoints - useq.RelativePosition

Parameters:

Name	Type	Description	Default
`plan`	`RelativeMultiPointPlan \| None`	The useq MultiPoint plan to display and edit.	`None`
`parent`	`QWidget \| None`	The parent widget.	`None`

Referenced by:

API Reference pymmcore-widgets
- pymmcore_widgets useq_widgets points_plans
  - Classes RelativePointPlanSelector
  - Re-exports
- API reference

valueChanged ¶

valueChanged = Signal(object)

Emitted with the new points plan when the widget changes.

value ¶

value() -> RelativeMultiPointPlan

Return the selected plan.

setValue ¶

setValue(plan: RelativeMultiPointPlan) -> None

Set the current plan.

setWellSize ¶

setWellSize(width: float | None = None, height: float | None = None) -> None

Set the well size width and/or height in mm.

setWellShape ¶

setWellShape(shape: Shape | str) -> None

Set the shape of the well.

Can be a useq.Shape enum or the strings "circle", "ellipse", "square", or "rectangle".

Attributes¶

PYMMCW_METADATA_KEY ¶

PYMMCW_METADATA_KEY = 'pymmcore_widgets'

Re-exports¶

These can also be imported from this module, but each is documented under its shortest import path (linked below).

Name	Description
`ChannelTable`	Table to edit a list of channels (`useq.Channel`).
`GridPlanWidget`	Widget to edit a grid plan.
`MDASequenceWidget`	A widget that provides a GUI to construct and edit a `useq.MDASequence`.
`PositionTable`	Table to edit a list of stage positions (`useq.Position`).
`TimePlanWidget`	Table to edit a time plan (`useq.AnyTimePlan`), one row per phase.
`ZPlanWidget`	Widget to edit a z plan (`useq.AnyZPlan`).

pymmcore_widgets.useq_widgets ¶

Classes¶

BoolColumn dataclass ¶

data_type ¶

ChoiceColumn dataclass ¶

data_type ¶

allowed_values ¶

isChecked ¶

setCheckState ¶

FloatColumn dataclass ¶

data_type ¶

IntColumn dataclass ¶

data_type ¶

minimum ¶

maximum ¶

TextColumn dataclass ¶

data_type ¶

header ¶

is_row_selector ¶

hidden ¶

default ¶

checkable ¶

checked ¶

init_cell ¶

get_cell_data ¶

set_cell_data ¶

isChecked ¶

setCheckState ¶

TimeDeltaColumn dataclass ¶

data_type ¶

minimum_unit ¶

DataTable ¶

valueChanged ¶

COLUMNS ¶

columnInfo ¶

addColumns ¶

addColumn ¶

indexOf ¶

iterRecords ¶

setValue ¶

checkAllRows ¶

clearChecks ¶

rowData ¶

setRowData ¶

DataTableWidget ¶

valueChanged ¶

COLUMNS ¶

table ¶

toolBar ¶

value ¶

setValue ¶

WellPlateWidget ¶

valueChanged ¶

setShowRotation ¶

value ¶

setValue ¶

currentSelection ¶

setCurrentSelection ¶

PointsPlanWidget ¶

valueChanged ¶

value ¶

setValue ¶

setWellSize ¶

setWellShape ¶

Attributes¶

PYMMCW_METADATA_KEY ¶

Re-exports¶

BoolColumn `dataclass` ¶

ChoiceColumn `dataclass` ¶

FloatColumn `dataclass` ¶

IntColumn `dataclass` ¶

TextColumn `dataclass` ¶

TimeDeltaColumn `dataclass` ¶