pylabrobot.resources.Plate#

class pylabrobot.resources.Plate(name: str, size_x: float, size_y: float, size_z: float, items: Optional[List[List[pylabrobot.resources.well.Well]]] = None, num_items_x: Optional[int] = None, num_items_y: Optional[int] = None, one_dot_max: Optional[float] = 0, category: str = 'plate', lid_height: float = 0, with_lid: bool = False, compute_volume_from_height: Optional[Callable[[float], float]] = None, model: Optional[str] = None)#

Bases: pylabrobot.resources.itemized_resource.ItemizedResource[pylabrobot.resources.well.Well]

Base class for Plate resources.

Attributes

name

Get the name of this resource.

num_items

The number of items on this resource.

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()

Get the center of this resource.

compute_volume_from_height(height)

Compute the volume of liquid in a well from the height of the liquid.

copy()

Copy this resource.

deserialize(data)

Deserialize a resource from a dictionary.

get_2d_center_offsets([n])

Get the offsets (from bottom left) of the center(s) of this resoure.

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_all_items()

Get all items in the resource.

get_item(identifier)

Get the item with the given identifier.

get_items(identifier)

Get the items with the given identifier.

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.

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 the resource was not found.

load_from_json_file(json_file)

Loads resources from a JSON file.

resource_assigned_callback(resource)

Called when a resource is assigned to this resource.

resource_unassigned_callback(resource)

Called when 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.

serialize()

Serialize this resource.

set_well_volumes(volumes)

Update the volume in the volume tracker of 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) –

  • items (Optional[List[List[Well]]]) –

  • num_items_x (Optional[int]) –

  • num_items_y (Optional[int]) –

  • one_dot_max (Optional[float]) –

  • category (str) –

  • lid_height (float) –

  • with_lid (bool) –

  • compute_volume_from_height (Optional[Callable[[float], float]]) –

  • model (Optional[str]) –