pylabrobot.bmg_labtech.vantastar.MeasurementSettings#

class pylabrobot.bmg_labtech.vantastar.MeasurementSettings(pause_before_reading: int | None = None, corner: Literal['top_left', 'top_right', 'bottom_left', 'bottom_right'] = 'top_left', reading_direction: Literal['column_major', 'row_major'] = 'row_major', bidirectional: bool = True, settling_time: float | None = None, well_scan: Literal['point', 'orbital', 'spiral', 'matrix'] = 'point', scan_diameter: int = 3, flashes: int | None = None, matrix_size: int | None = None)#

Bases: object

How a read reads the plate: the fields of the CLARIOstar’s MeasurementSettings, with the VANTAstar’s defaults and ranges.

Variables:

  • pause_before_reading (int | None) – whole seconds to wait before the read, after any shaking; None does not wait. The driver waits; the reader is idle meanwhile.

  • corner (Literal['top_left', 'top_right', 'bottom_left', 'bottom_right']) – the corner the reader starts at.

  • reading_direction (Literal['column_major', 'row_major']) – row_major reads row by row (the reader’s default); column_major column by column.

  • bidirectional (bool) – read every other row or column backwards (meander, the default); False reads all in one direction. Results are in plate order whatever the reading order.

  • settling_time (float | None) – seconds to settle before each well, 0.02-1.0 in 20 ms steps (the reader refuses others, quit code 43); None for the read’s default.

  • well_scan (Literal['point', 'orbital', 'spiral', 'matrix']) – read each well at its centre (point), or average along a circle (orbital) or a spiral of scan_diameter. A matrix well scan is not supported.

  • scan_diameter (int) – orbital or spiral diameter, a whole mm from 1 to the plate’s well diameter (the reader refuses a wider one, quit code 65).

  • flashes (int | None) – flashes per well, 1-500 (the reader refuses more, quit code 60); None for the read’s default.

  • matrix_size (int | None) – points per side of a matrix scan; a matrix well scan is not supported, so None.

Raises:

ValueError – on construction, listing every field of the wrong kind or out of the reader’s range (check adds the rules that need the plate).

Parameters:

  • pause_before_reading (int | None)

  • corner (Literal['top_left', 'top_right', 'bottom_left', 'bottom_right'])

  • reading_direction (Literal['column_major', 'row_major'])

  • bidirectional (bool)

  • settling_time (float | None)

  • well_scan (Literal['point', 'orbital', 'spiral', 'matrix'])

  • scan_diameter (int)

  • flashes (int | None)

  • matrix_size (int | None)

Attributes

bidirectional

corner

flashes

matrix_size

pause_before_reading

reading_direction

scan_diameter

settling_time

well_scan

Methods

__init__([pause_before_reading, corner, ...])

check(plate)

Raise if these settings cannot read plate: a well scan wider than its wells.