pylabrobot.plate_reading.plate_reader.PlateReader

class pylabrobot.plate_reading.plate_reader.PlateReader(name: str, size_x: float, size_y: float, size_z: float, backend: PlateReaderBackend, category: str | None = None, model: str | None = None)

Bases: Machine

The front end for plate readers. Plate readers are devices that can read luminescence, absorbance, or fluorescence from a plate.

Plate readers are asynchronous, meaning that their methods will return immediately and will not block.

Here’s an example of how to use this class in a Jupyter Notebook:

>>> from pylabrobot.plate_reading.clario_star import CLARIOStar
>>> pr = PlateReader(backend=CLARIOStar())
>>> pr.setup()
>>> await pr.read_luminescence()
[[value1, value2, value3, ...], [value1, value2, value3, ...], ...

Attributes

name	Get the name of this resource.
setup_finished

Methods

__init__(name, size_x, size_y, size_z, backend)
assign_child_resource(resource)	Assign a child resource to this resource.
center([x, y, z])	Get the center of this resource.
centers([xn, yn, zn])	Get equally spaced points in the x, y, and z directions.
close()
copy()	Copy this resource.
deregister_did_assign_resource_callback(callback)	Remove a callback that will be called after a resource is assigned to this resource.
deregister_did_unassign_resource_callback(...)	Remove a callback that will be called after a resource is unassigned from this resource.
deregister_state_update_callback(callback)	Remove a callback that will be called when the state of the resource changes.
deregister_will_assign_resource_callback(...)	Remove a callback that will be called before a resource is assigned to this resource.
deregister_will_unassign_resource_callback(...)	Remove a callback that will be called before a resource is unassigned from this resource.
deserialize(data)	Deserialize a resource from a dictionary.
get_absolute_location()	Get the absolute location of this resource, probably within the pylabrobot.resources.Deck.
get_all_children()	Recursively get all children of this resource.
get_plate()
get_resource(name)	Get a resource by name.
get_size_x()
get_size_y()
get_size_z()	Get the size of this resource in the z-direction.
load_all_state(state)	Load state for this resource and all children.
load_from_json_file(json_file)	Loads resources from a JSON file.
load_state(state)	Load state for this resource only.
load_state_from_file(fn)	Load the state of this resource and all children from a JSON file.
open()
read_absorbance(wavelength, report)	Read the absorbance from the plate in either OD or transmittance.
read_luminescence(focal_height)	Read the luminescence from the plate.
register_did_assign_resource_callback(callback)	Add a callback that will be called after a resource is assigned to this resource.
register_did_unassign_resource_callback(callback)	Add a callback that will be called after a resource is unassigned from this resource.
register_state_update_callback(callback)	Register a callback that will be called when the state of the resource changes.
register_will_assign_resource_callback(callback)	Add a callback that will be called before a resource is assigned to this resource.
register_will_unassign_resource_callback(...)	Add a callback that will be called before a resource is unassigned from this resource.
rotate(degrees)	Rotate counter clockwise by the given number of degrees.
rotated(degrees)	Return a copy of this resource rotated by the given number of degrees.
save(fn[, indent])	Save a resource to a JSON file.
save_state_to_file(fn[, indent])	Save the state of this resource and all children to a JSON file.
serialize()	Serialize this resource.
serialize_all_state()	Serialize the state of this resource and all children.
serialize_state()	Serialize the state of this resource only.
setup()
stop()
unassign()	Unassign this resource from its parent.
unassign_child_resource(resource)	Unassign a child resource from this resource.

Parameters:

• name (str)

• size_x (float)

• size_y (float)

• size_z (float)

• backend (PlateReaderBackend)

• category (str | None)

• model (str | None)