pylabrobot.resources.Plate

class pylabrobot.resources.Plate(name: str, size_x: float, size_y: float, size_z: float, ordered_items: Dict[str, Well] | None = None, ordering: List[str] | None = None, category: str = 'plate', lid: Lid | None = None, model: str | None = None, plate_type: Literal['skirted', 'semi-skirted', 'non-skirted'] = 'skirted')

Bases: ItemizedResource[Well]

Base class for Plate resources.

Attributes

items
lid
name	Get the name of this resource.
num_items
num_items_x	The number of items in the x direction, if the resource is a full grid.
num_items_y	The number of items in the y direction, if the resource is a full grid.

Methods

__init__(name, size_x, size_y, size_z[, ...])	Initialize a Plate resource.
assign_child_resource(resource[, location, ...])	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.
copy()
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[, allow_marshal])	Deserialize a resource from a dictionary.
disable_volume_trackers()	Disable volume tracking for all wells in the plate.
enable_volume_trackers()	Enable volume tracking for all wells in the plate.
get_absolute_location([x, y, z])	Get the absolute location of this resource, probably within the pylabrobot.resources.Deck.
get_absolute_rotation()	Get the absolute rotation of this resource.
get_absolute_size_x()	Get the absolute size in the x direction.
get_absolute_size_y()	Get the absolute size in the y direction.
get_absolute_size_z()	Get the absolute size in the z direction.
get_all_children()	Recursively get all children of this resource.
get_all_items()	Get all items in the resource.
get_anchor(x, y, z)	Get a relative location within the resource.
get_highest_known_point()	Recursively finds the highest known point in absolute space.
get_item(identifier)	Get the item with the given identifier.
get_items(identifiers)	Get the items with the given identifier.
get_quadrant(quadrant)	Return the wells in the specified quadrant.
get_resource(name)	Get a resource by name.
get_root()	Get the root of the resource tree.
get_size_x()	Local size in the x direction.
get_size_y()	Local size in the y direction.
get_size_z()	Local size in the z direction.
get_well(identifier)	Get the item with the given identifier.
get_wells(identifier)	Get the wells with the given identifier.
has_lid()
index_of_item(item)	Return the index of the given item in the resource, or None if not found.
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.
make_grid([occupied_func])
print_grid([occupied_func])
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([x, y, z])	Rotate counter-clockwise by the given number of degrees.
rotated([x, y, z])	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.
set_well_liquids(liquids)	Update the liquid in the volume tracker for each well in the plate.
traverse(batch_size, direction[, repeat])	Traverse the items in this resource.
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)

• ordered_items (Optional[Dict[str, Well]])

• ordering (Optional[List[str]])

• category (str)

• lid (Optional[Lid])

• model (Optional[str])

• plate_type (Literal['skirted', 'semi-skirted', 'non-skirted'])