pylabrobot.bmg_labtech.vantastar.driver.master.VANTAstarDriver.build_gain_focus#

VANTAstarDriver.build_gain_focus(monochromator: MonochromatorSettings, *, focal_height: float, target_percent: float, adjust_focus: bool, geometry: PlateGeometry = PlateGeometry(length=127.76, width=85.48, first_x=14.38, first_y=11.24, last_x=113.38, last_y=74.24, columns=12, rows=8, well_size=6.58, well_shape=0), well_mask: bytes | None = None, well_scan: Literal['point', 'orbital', 'spiral', 'matrix'] = 'point', scan_diameter: int = 3, flashes: int = 0, focal_height_step: float = 0.2) → bytes#

GainPlateCommand fields for a top fluorescence gain and focus adjustment, either alone.

Parameters:

  • monochromator (MonochromatorSettings) – the read’s monochromator settings.

  • focal_height (float) – mm; the height the gain is adjusted at when the focus is not.

  • target_percent (float) – the gain’s target, percent of the detector range; 0 adjusts only the focus.

  • adjust_focus (bool) – also find the focal height (a scan from 16 mm down in focal_height_step).

  • geometry (PlateGeometry) – the plate.

  • well_mask (bytes | None) – the reference wells (encode_well_mask); None uses every well.

  • well_scan (Literal['point', 'orbital', 'spiral', 'matrix']) – adjust over the area a well-scanning read reads (point: at the centre); scan_diameter: its diameter, mm.

  • flashes (int) – flashes per well, sent with an orbital or spiral scan.

  • focal_height_step (float) – mm between the focus scan’s points (Voyager’s 0.2 mm).

  • scan_diameter (int)

Raises:

ValueError – if target_percent is not 0-100.

Return type:

bytes