Skip to content

Commit c44ebc9

Browse files
ieivanovclaude
andcommitted
docs: update docstrings for plate_row, plate_col, and name_pattern
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent e29b780 commit c44ebc9

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

src/useq/_grid.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ class _GridPlan(_MultiPointPlan[PositionT]):
6161
Height of the field of view in microns. If not provided, acquisition engines
6262
should use current height of the FOV based on the current objective and camera.
6363
Engines MAY override this even if provided.
64+
name_pattern : str
65+
Format pattern for grid position names. Supported variables are
66+
``{row}``, ``{col}``, and ``{idx}``. By default, ``"{idx:04d}"``.
6467
"""
6568

6669
overlap: tuple[float, float] = Field(default=(0.0, 0.0), frozen=True)

src/useq/_position.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,16 @@ class PositionBase(MutableModel):
4040
z : float | None
4141
Z position in microns.
4242
name : str | None
43-
Optional name for the position.
43+
Optional name for the position. If not provided but `plate_row` and
44+
`plate_col` are set, a well name is auto-generated (e.g., "A1").
4445
sequence : MDASequence | None
4546
Optional MDASequence relative this position.
47+
plate_row : int | None
48+
Optional 0-based row index for well plate positions. Used to indicate
49+
which well this position belongs to for HCS data storage.
50+
plate_col : int | None
51+
Optional 0-based column index for well plate positions. Used together
52+
with `plate_row` to identify the well.
4653
row : int | None
4754
Optional row index, when used in a grid.
4855
col : int | None

0 commit comments

Comments
 (0)