pylabrobot.resources.Deck#

class pylabrobot.resources.Deck(name: str = 'deck', size_x: float = 1360, size_y: float = 653.5, size_z: float = 900, resource_assigned_callback: Callable | None = None, resource_unassigned_callback: Callable | None = None, origin: Coordinate = Coordinate(x=0, y=0, z=0), category: str = 'deck')#

Bases: Resource

Base class for liquid handler decks.

Attributes

name

Get the name of this resource.

Methods

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

Initialize a new deck.

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

Assign a child resource to this resource.

center()

Get the center of the bottom plane of this resource.

clear()

Removes all resources from the deck.

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

Returns a list of all resources in the deck.

get_resource(name)

Returns the resource with the given name.

get_size_x()

get_size_y()

get_size_z()

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

get_trash_area()

Returns the trash area resource.

has_resource(name)

Returns True if the deck has a resource with the given name.

load_from_json_file(json_file)

Loads resources from a JSON file.

load_state(data)

Load state from a data dictionary.

load_state_from_file(filename)

Load the state of the deck from a file.

resource_assigned_callback(resource)

  • Keeps track of the resources in the deck.

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.

save_state_to_file(filename)

Save the state of the deck to a file.

serialize()

Serialize this deck.

serialize_state()

Serialize the deck state.

summary()

Returns a summary of the deck layout.

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

  • resource_assigned_callback (Optional[Callable]) –

  • resource_unassigned_callback (Optional[Callable]) –

  • origin (Coordinate) –

  • category (str) –