pylabrobot.liquid_handling.liquid_handler.LiquidHandler#

class pylabrobot.liquid_handling.liquid_handler.LiquidHandler(backend: LiquidHandlerBackend, deck: Deck, default_offset_head96: Coordinate | None = None)#

Bases: Resource, Machine

Front end for liquid handlers.

This class is the front end for liquid handlers; it provides a high-level interface for interacting with liquid handlers. In the background, this class uses the low-level backend ( defined in pyhamilton.liquid_handling.backends) to communicate with the liquid handler.

Attributes

name

Get the name of this resource.

setup_finished

Methods

__init__(backend, deck[, default_offset_head96])

Initialize a LiquidHandler.

aspirate(resources, vols[, use_channels, ...])

Aspirate liquid from the specified wells.

aspirate96(resource, volume[, offset, ...])

Aspirate from all wells in a plate or from a container of a sufficient size.

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

Not implement on LiquidHandler, since the deck is managed by the deck attribute.

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.

clear_head_state()

Clear the state of the liquid handler head.

consolidate_tip_inventory(tip_racks[, ...])

Consolidate partial tip racks on the deck by redistributing tips.

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 liquid handler from a dictionary.

discard_tips([use_channels, ...])

Permanently discard tips in the trash.

discard_tips96([allow_nonzero_volume])

Permanently discard tips from the 96 head in the trash.

dispense(resources, vols[, use_channels, ...])

Dispense liquid to the specified channels.

dispense96(resource, volume[, offset, ...])

Dispense to all wells in a plate.

drop_resource(destination[, offset, direction])

drop_tips(tip_spots[, use_channels, ...])

Drop tips to a resource.

drop_tips96(resource[, offset, ...])

Drop tips using the 96 head.

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_anchor([x, y, z])

Get a relative location within the resource.

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

get_mounted_tips()

Get the tips currently mounted on the head.

get_picked_up_resource()

Get the resource that is currently picked up.

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.

is_in_subtree_of(other)

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

load(path)

Load a liquid handler from a file.

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 the liquid handler state from a file.

load_state_from_file(fn)

Load the state of this resource and all children from a JSON file.

move_channel_x(channel, x)

Move channel to absolute x position

move_channel_y(channel, y)

Move channel to absolute y position

move_channel_z(channel, z)

Move channel to absolute z position

move_lid(lid, to[, intermediate_locations, ...])

Move a lid to a new location.

move_picked_up_resource(to[, offset, direction])

Move a resource that has been picked up to a new location.

move_plate(plate, to[, ...])

Move a plate to a new location.

move_resource(resource, to[, ...])

Move a resource to a new location.

move_tips(source_tip_spots, dest_tip_spots)

Move tips from one tip rack to another.

pick_up_resource(resource[, offset, ...])

pick_up_tips(tip_spots[, use_channels, offsets])

Pick up tips from a resource.

pick_up_tips96(tip_rack[, offset])

Pick up tips using the 96 head.

prepare_for_manual_channel_operation(channel)

probe_tip_inventory(tip_spots[, probing_fn, ...])

Probe the presence of tips in multiple tip spots.

probe_tip_presence_via_pickup(tip_spots[, ...])

Probe tip presence by attempting pickup on each TipSpot.

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.

return_tips([use_channels, allow_nonzero_volume])

Return all tips that are currently picked up to their original place.

return_tips96([allow_nonzero_volume, offset])

Return the tips on the 96 head to the tip rack where they were picked up.

rotate([x, y, z])

Rotate counter-clockwise by the given number of degrees.

rotated([x, y, z])

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

Serialize the state of this resource and all children.

serialize_state()

Serialize the state of this liquid handler.

setup(**backend_kwargs)

Prepare the robot for use.

stamp(source, target, volume[, ...])

Stamp (aspiration and dispense) one plate onto another.

stop()

summary()

Prints a string summary of the deck layout.

transfer(source, targets[, source_vol, ...])

Transfer liquid from one well to another.

unassign()

Unassign this resource from its parent.

unassign_child_resource(resource)

Unassign a child resource from this resource.

update_head_state(state)

Update the state of the liquid handler head.

use_channels(channels)

Temporarily use the specified channels as a default argument to use_channels.

use_tips(tip_spots[, channels, discard])

Temporarily pick up tips from the specified tip spots on the specified channels.
Parameters: