Skip to content

feat(api): add x,y WellOffset for wells with an even number of subsections #19155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: edge
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions api/src/opentrons/protocol_engine/state/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,42 @@ def validate_probed_height(
f"Liquid Height of {probed_height} mm is greater than maximum well height {well_depth} mm."
)

def _get_xy_offset_if_needed(self, labware_id: str, well_name: str) -> Point:
"""Add an x,y offset to position the tip into the center of a sub-well if needed."""
labware_definition = self._labware.get_definition(labware_id)
if labware_definition.innerLabwareGeometry is None:
return Point(x=0, y=0, z=0)
well_def = self._labware.get_well_definition(labware_id, well_name)
well_geometry = self._labware.get_well_geometry(
labware_id=labware_id, well_name=well_name
)
x_offset = 0.0
y_offset = 0.0
if isinstance(well_geometry, InnerWellGeometry):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we can simplify this a bit:

well_def = ...
well_geometry = ...
if isinstance(well_geometry, InnerWellGeometry):
    ...
else:
    return Point(x=0, y=0, z=0)

this also means we don't have to have the early creation of x_offset and y_offset

sorted_well = sorted(
well_geometry.sections, key=lambda section: section.topHeight
)
bottom_xcount = sorted_well[0].xCount
bottom_ycount = sorted_well[0].yCount

if well_def.shape == "circular":
well_x_dimension = well_y_dimension = well_def.diameter
else:
well_x_dimension = well_def.xDimension
well_y_dimension = well_def.yDimension

# if there are an even number of subsections, we'll need to reposition into
# the middle of one of the subsections, rather than the middle of the whole well.
if bottom_xcount % 2 == 0:
subsection_x_dimension = well_x_dimension / bottom_xcount
# move over into the middle of the nearest subsection
x_offset = subsection_x_dimension / 2
if bottom_ycount % 2 == 0:
subsection_y_dimension = well_y_dimension / bottom_ycount
# move over into the middle of the nearest subection
y_offset = subsection_y_dimension / 2
return Point(x=x_offset, y=y_offset, z=0)

def get_well_position(
self,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Can we add unit tests covering the new get_well_position() behavior?

labware_id: str,
Expand All @@ -600,8 +636,10 @@ def get_well_position(
labware_pos = self.get_labware_position(labware_id)
well_def = self._labware.get_well_definition(labware_id, well_name)
well_depth = well_def.depth

offset = WellOffset(x=0, y=0, z=well_depth)
xy_offset = self._get_xy_offset_if_needed(
labware_id=labware_id, well_name=well_name
)
offset = WellOffset(x=xy_offset.x, y=xy_offset.y, z=well_depth)
if well_location is not None:
offset = well_location.offset # location of the bottom of the well
offset_adjustment = self.get_well_offset_adjustment(
Expand Down
Loading