pylabrobot.resources.tip_rack.EmbeddedTipRack

class pylabrobot.resources.tip_rack.EmbeddedTipRack(name: str, size_x: float, size_y: float, size_z: float, sinking_depth: float, ordered_items: Dict[str, TipSpot] | None = None, ordering: OrderedDict[str, str] | None = None, category: str = 'tip_rack', model: str | None = None, with_tips: bool = True, frame_height: float | None = None, metadata: Mapping[str, Any] | None = None)

Bases: TipRack

The EmbeddedTipRack - this is what some might call a “standard” TipRack; they cannot stand on their own, they require an EmbeddedTipRackHolder at all times to be functional.

have historically been referred to as FTRs (officially “framed tip rack” from Hamilton, sometimes we used to call them “floating tip racks”.

Attributes

available_for_tip_handling	it is placed, has no lid on, and no other rack stands on it in its stack.
frame_height	Return frame_height, raising if it is None.
item_dx	The spacing between items in the x direction.
item_dy	The spacing between items in the y direction.
items
lid	The lid seated on this resource, or None.
location	Where this resource sits, relative to its parent.
name	Get the name of this resource.
num_items
num_items_x	The number of items in the x direction, if the resource is a full grid.
num_items_y	The number of items in the y direction, if the resource is a full grid.

Methods

__init__(name, size_x, size_y, size_z, ...)	sinking_depth: the depth the tip rack sinks into the tip holder when placed inside it.
assign_child_by_anchor(resource[, ...])	Assign a child resource by aligning anchor points.
assign_child_resource(resource[, location, ...])	Assign a child resource to this 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.
column(column)	Get all items in the given column.
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.
disable_tip_trackers()	Deprecated: use disable_tip_tracking.
disable_tip_tracking()	Disable tip tracking for every spot in this tip rack.
empty()	Empty the tip rack.
enable_tip_trackers()	Deprecated: use enable_tip_tracking.
enable_tip_tracking()	Enable tip tracking for every spot in this tip rack.
fill()	Fill the tip rack.
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_items()	Get all items in the resource.
get_all_tips()	Get all tips in the tip rack.
get_anchor([x, y, z])	Get a relative location within the resource.
get_child_column(item)	Get the column of the item.
get_child_identifier(item)	Get the identifier of the item.
get_child_row(item)	Get the row of the item.
get_highest_known_point()	Recursively finds the highest known point in absolute space.
get_item(identifier)	Get the item with the given identifier.
get_items(identifiers)	Get the items with the given identifier.
get_lid_location(lid)	Location of lid seated centred on this resource's top face, sunk by nesting_z_height.
get_location_wrt(other[, x, y, z])	Get the location of this resource with respect to another, along the other's axes.
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(identifier)	Get the item with the given identifier.
get_tips(identifier)	Get the tips with the given identifier.
has_lid()
has_resource(name)	Whether anything at or beneath this resource carries the given name.
index_of_item(item)	Return the index of the given item in the resource, or None if not found.
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.
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.
row(row)	Get all items in the given row.
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 resource only.
set_tip_state(tips)	Set the initial tip tracking state of all tips in this tip rack.
summary([occupied_func])
traverse(batch_size, start, direction[, repeat])	Traverse the items in this resource.
unassign()	Unassign this resource from its parent.
unassign_child_resource(resource)	Unassign a child resource from this resource.

Parameters:

• name (str)

• size_x (float)

• size_y (float)

• size_z (float)

• sinking_depth (float)

• ordered_items (Optional[Dict[str, TipSpot]])

• ordering (Optional[OrderedDict[str, str]])

• category (str)

• model (Optional[str])

• with_tips (bool)

• frame_height (Optional[float])

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