pylabrobot.resources.hamilton.hamilton_decks.HamiltonDeck#

class pylabrobot.resources.hamilton.hamilton_decks.HamiltonDeck(num_tracks: int | None = None, size_x: float | None = None, size_y: float | None = None, size_z: float | None = None, name: str = 'deck', category: str = 'deck', origin: Coordinate = Coordinate(x=0, y=0, z=0), num_rails: int | None = None, model: str | None = None)#

Bases: Deck

Hamilton decks. Currently only STARLet, STAR and Vantage are supported.

Attributes

location

Where this resource sits, relative to its parent.

name

Get the name of this resource.

num_rails

Deprecated.

safe_deck_height

Up to this height, in mm of the deck's frame (145 above its surface), a resource is under a traversing channel whatever tip it carries: the stop discs at Z safety, 334.7, less the 87.1 mm a 1000 uL tip reaches below them, with margin.

Methods

__init__([num_tracks, size_x, size_y, ...])

Initialize a new deck.

assign_child_by_anchor(resource[, ...])

Assign a child resource by aligning anchor points.

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

Assign a new deck resource.

at(location)

Return a copy of this resource at the given location.

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.

check_can_drop_resource_here(resource, *[, ...])

Validate whether resource may be dropped onto this resource.

clear([include_trash])

Removes all resources from the deck.

compute_right_track_of_carrier(carrier)

The last track a carrier covers, from where it sits on this deck.

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.

find_resource([fn, metadata, has_metadata, ...])

Find the first matching resource, or None if not found.

find_resources([fn, metadata, has_metadata, ...])

Find resources matching top-level attributes, metadata, and/or a predicate.

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

Returns a list of all resources in the deck.

get_anchor([x, y, z])

Get a relative location within the resource.

get_carrier_at_track(track)

The carrier covering a track, from where the carriers sit on this deck.

get_highest_known_point()

Recursively finds the highest known point in absolute space.

get_location_wrt(other[, x, y, z])

Get the location of this resource with respect to another, along the other's axes.

get_or_create_autoload_loading_tray(name)

Get, or create once, the deck-owned loading tray the autoload draws carriers from.

get_or_create_autoload_sled(name, x, ...)

Get, or create once, the deck-owned autoload sled.

get_or_create_x_arm(name, x, size_x, ...)

Get, or create once, the deck-owned X-arm resource called name.

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

Returns the trash area resource.

get_trash_area96()

has_resource(name)

Whether anything at or beneath this resource carries the given name.

is_in_subtree_of(other)

Return True if self is in the subtree rooted at other.

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.

named(name)

Return a copy of this resource with the given name.

rails_to_location(rails)

Deprecated.

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, pivot_coordinate])

Rotate counter-clockwise around the parent-coordinate axes by the given degrees.

rotate_to([x, y, z, pivot_coordinate])

Set the rotation about each axis, where rotate turns by an amount instead.

rotated([x, y, z, pivot_coordinate])

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

serialize_all_state()

Serialize the state of this resource and all children.

serialize_state()

Serialize the state of this resource only.

summary()

Return a summary of the deck.

track_to_location(track)

Where a track starts on this deck.

unassign()

Unassign this resource from its parent.

unassign_child_resource(resource)

Unassign a child resource from this resource.
Parameters: