pylabrobot.bmg_labtech.vantastar.driver.features.fluorescence.Fluorescence.measure#
- async Fluorescence.measure(fluorescence_channels: FluorescenceChannel, *, gain: int | None = None, wells: Sequence[Well] | None = None, focal_height: float | None = None, enhanced_dynamic_range: bool = False, monochromator: MonochromatorSettings | None = None, plate: Plate | None = None, measurement_settings: MeasurementSettings | None = None, shake_settings: ShakeSettings | None = None, timeout: float = 300.0) FluorescenceResult#
- async Fluorescence.measure(fluorescence_channels: Sequence[FluorescenceChannel], *, gain: int | Sequence[int] | None = None, wells: Sequence[Well] | None = None, focal_height: float | None = None, enhanced_dynamic_range: bool = False, monochromator: Sequence[MonochromatorSettings] | None = None, plate: Plate | None = None, measurement_settings: MeasurementSettings | None = None, shake_settings: ShakeSettings | None = None, timeout: float = 300.0) List[FluorescenceResult]
Measure the fluorescence intensity of the plate from the top (endpoint), through one fluorescence channel or several in one pass.
The monochromator band edges are the nominal ones, wavelength +/- bandwidth / 2. Voyager places them closer together, by an amount its filter software computes from the wavelength, bandwidth and slit; narrow bands differ most (excitation 365/8 and emission 400/10: Voyager 362.9-367.1 and 397.8-402.2 nm, nominal 361-369 and 395-405 nm), bands of 20 nm and more by a few tenths of a nm. Readings at narrow bandwidths are therefore not directly comparable with Voyager’s. To read with Voyager’s edges, pass them as
monochromator. Several channels are read in one pass, each well through every channel in turn.- Parameters:
fluorescence_channels (FluorescenceChannel | Sequence[FluorescenceChannel]) – one
FluorescenceChannel, or a sequence of up to 5 (the reader refuses a sixth, quit code 60): excitation and emission wavelength each, the bandwidths (8-100 nm;default_excitation_bandwidthanddefault_emission_bandwidthwhen None) and the dichroic split (None sets it as Voyager does automatically, midway between the excitation’s upper and the emission’s lower edge; the tested reader refuses a dichroic above 760 nm, quit code 67). No filters.gain (int | Sequence[int] | None) – the detector gain, one for every channel or one per channel; required unless
enhanced_dynamic_range.wells (Sequence[Well] | None) – the wells to measure; None measures every well.
focal_height (float | None) – mm above the plate’s base, in 0.1 mm steps; None takes
default_focal_height_percent_of_well_depthof the wells’ depth above their floor (adjust_gain_and_focusfinds one).enhanced_dynamic_range (bool) – read with enhanced dynamic range; no gain is sent.
monochromator (MonochromatorSettings | Sequence[MonochromatorSettings] | None) – band edges, dichroic and slits to read with instead of the computed ones, one per channel.
plate (Plate | None) – the plate to measure; None uses the plate on the plate holder.
measurement_settings (MeasurementSettings | None) – how to read; None reads with the defaults (20 flashes, 0.5 s).
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 – one result for one channel, a list of results (one per channel, in the order given) for a sequence.
- 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:
FluorescenceResult | List[FluorescenceResult]