pylabrobot.resources.tip_rack.TipSpot#

class pylabrobot.resources.tip_rack.TipSpot(name: str, size_x: float, size_y: float, make_tip: Callable[[str], Tip], size_z: float = 0, category: str = 'tip_spot', metadata: Mapping[str, Any] | None = None)#

Bases: Resource

A tip spot, a location in a tip rack where there may or may not be a tip.

Each tip produced by this spot is given a unique name based on the parent rack name, the spot name, and a per-spot counter (e.g. rack.A1#1, rack.A1#2), which is stored on the Tip instance.

Attributes

location

Where this resource sits, relative to its parent.

name

Get the name of this resource.

tip

The tip this spot holds in the resource tree, or None if it holds none.

tracker

the legacy liquid handler's tracker for this spot.

tracks_tips

tip tracking is on, and not disabled for this spot.

Methods

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

Initialize a tip spot.

assign_child_by_anchor(resource[, ...])

Assign a child resource by aligning anchor points.

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

Assign a child.

assign_tip(tip)

Put a tip in this spot, resting by its collar, wherever it was before.

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.

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 tip spot.

disable_tip_tracking()

Leave this spot as it is whatever is picked up from it or dropped into it.

empty()

Deprecated: empty the tip spot.

enable_tip_tracking()

Track this spot again, when tip tracking is on.

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_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_identifier()

Get the (canonical) identifier, like "A1" of the tip spot in the parent tip rack.

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

Get the location of this resource with respect to another resource.

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

Deprecated: get a tip from the tip spot.

has_resource(name)

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

has_tip()

Deprecated: check if the tip spot has a tip.

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 this spot's state: the saved pending_tip goes into it, as this spot's child.

load_state_from_file(fn)

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

make_tip()

Create a new tip instance for this spot and assign it a unique name.

named(name)

Return a copy of this resource with the given name.

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 the tip spot.

serialize_all_state()

Serialize the state of this resource and all children.

serialize_state()

This spot's state, with the tip it holds in the tree: tip, tip_state and pending_tip.

tip_for_pickup()

The tip a channel picking up from this spot collects.

unassign()

Unassign this resource from its parent.

unassign_child_resource(resource)

Unassign a child resource from this resource.

unassign_tip()

Take the tip out of this spot.

Parameters:
  • name (str)

  • size_x (float)

  • size_y (float)

  • make_tip (TipCreator)

  • size_z (float)

  • category (str)

  • metadata (Optional[Mapping[str, Any]])