pylabrobot.resources.PlateCarrier#

class pylabrobot.resources.PlateCarrier(name: str, size_x: float, size_y: float, size_z: float, sites: Optional[List[CarrierSite]] = None, category='plate_carrier', model: Optional[str] = None)#

Bases: Carrier

Base class for plate carriers.

Attributes

name

Get the name of this resource.

Methods

__init__(name, size_x, size_y, size_z[, ...])

assign_child_resource(resource, location[, ...])

Assign a resource to this carrier.

assign_resource_to_site(resource, spot)

center()

Get the center of the bottom plane of this resource.

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 resource.

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

Get a resource by name.

get_resources()

Get all resources, using self.__getitem__ (so that the location is within this carrier).

get_sites()

Get all sites.

get_size_x()

get_size_y()

get_size_z()

Get the size of this resource in the z-direction.

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.

unassign()

Unassign this resource from its parent.

unassign_child_resource(resource)

Unassign a resource from this carrier, checked by name.

Parameters:
  • name (str) –

  • size_x (float) –

  • size_y (float) –

  • size_z (float) –

  • sites (Optional[List[CarrierSite]]) –

  • model (Optional[str]) –