pylabrobot.liquid_handling.liquid_handler.LiquidHandler

Contents

pylabrobot.liquid_handling.liquid_handler.LiquidHandler#

class pylabrobot.liquid_handling.liquid_handler.LiquidHandler(backend: LiquidHandlerBackend, deck: Deck)#

Bases: 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

ALLOWED_CALLBACKS

callbacks

name

Get the name of this resource.

setup_finished

Methods

__init__(backend, deck)

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.

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

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

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.

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)

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_tips(tip_spots[, use_channels, ...])

Drop tips to a resource.

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

Drop tips using the 96 head.

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(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_lid(lid, to[, intermediate_locations, ...])

Move a lid 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.

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.

register_callback(method_name, callback)

Registers a callback for a specific method.

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

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

return_tips96([allow_nonzero_volume])

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

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(fn[, indent])

Save the state of this resource and all children to a JSON file.

serialize()

Serialize this resource.

serialize_all_state()

Serialize the state of this resource and all children.

serialize_state()

Serialize the state of this liquid handler.

setup()

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.

unassign_resource(resource)

Unassign an assigned 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.

Parameters: