pylabrobot.resources.Resource#

class pylabrobot.resources.Resource(name: str, size_x: float, size_y: float, size_z: float, category: Optional[str] = None, model: Optional[str] = None)#

Bases: object

Base class for deck resources.

Parameters:

  • name (str) – The name of the resource.

  • size_x (float) – The size of the resource in the x-direction.

  • size_y (float) – The size of the resource in the y-direction.

  • size_z (float) – The size of the resource in the z-direction.

  • location – The location of the resource, relative to its parent. (see get_absolute_location())

  • category (Optional[str]) – The category of the resource, e.g. tips, plate_carrier, etc.

  • model (Optional[str]) –

Attributes

name

Get the name of this resource.

Methods

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

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

Assign a child resource to this resource.

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_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 child resource from this resource.