pylabrobot.bmg_labtech.vantastar.driver.features.luminescence.Luminescence.measure#

async Luminescence.measure(*, integration_time: float = 0.8, gain: int | None = None, aperture_distance: float = 0.5, monochromator: MonochromatorSettings = MonochromatorSettings(excitation_lower=0, excitation_upper=0, dichroic=0.1, emission_lower=0.1, emission_upper=0.1, excitation_slit=0, emission_slit=6), plate: Plate | None = None, wells: Sequence[Well] | None = None, measurement_settings: MeasurementSettings | None = None, shake_settings: ShakeSettings | None = None, timeout: float = 600.0) → LuminescenceResult#

Measure the luminescence of the plate from the top (endpoint). NOT TESTED on a reader with luminescence; a reader without the luminescence module refuses it (CommandRefusedError, quit code 205).

The defaults are those of Voyager’s luminescence protocol: all the emitted light, automatic gain, 0.8 s per well, 0.5 mm aperture distance, 20 ms settling. Neither the command nor the decoding of its data has run on a reader with luminescence. Please report how it behaves.

Parameters:
  • integration_time (float) – seconds of light collection per well (0.01-655.35, 10 ms steps).

  • gain (int | None) – the detector gain; None for the reader’s automatic gain.

  • aperture_distance (float) – mm between the top optic’s aperture and the plate (0.01 mm steps).

  • monochromator (MonochromatorSettings) – the emission settings; the default reads all the emitted light, as Voyager’s luminescence protocol does.

  • plate (Plate | None) – the plate to measure; None uses the plate on the plate holder.

  • wells (Sequence[Well] | None) – the wells to measure; None measures every well.

  • measurement_settings (MeasurementSettings | None) – how to read; None reads with the defaults (20 ms settling). Its flashes and well_scan do not apply: a luminescence read integrates at the centre.

  • shake_settings (ShakeSettings | None) – shake the plate before the read; None does not shake.

  • timeout (float) – seconds the run may take.

Returns:

The counts of the measured wells.

Raises:
  • RuntimeError – if no plate is on the plate holder or the run ends without its data.

  • ValueError – if an argument is out of range.

Return type:

LuminescenceResult