Ctrl+K

pylabrobot.liquid_handling.backends.hamilton.STAR.STAR.aspirate

Contents

pylabrobot.liquid_handling.backends.hamilton.STAR.STAR.aspirate#

async STAR.aspirate(ops: List[Aspiration], use_channels: List[int], jet: List[bool] | None = None, blow_out: List[bool] | None = None, lld_search_height: List[int] | None = None, clot_detection_height: List[int] | None = None, pull_out_distance_transport_air: List[int] | None = None, second_section_height: List[int] | None = None, second_section_ratio: List[int] | None = None, minimum_height: List[int] | None = None, immersion_depth: List[int] | None = None, immersion_depth_direction: List[int] | None = None, surface_following_distance: List[int] | None = None, transport_air_volume: List[int] | None = None, pre_wetting_volume: List[int] | None = None, lld_mode: List[LLDMode] | None = None, gamma_lld_sensitivity: List[int] | None = None, dp_lld_sensitivity: List[int] | None = None, aspirate_position_above_z_touch_off: List[int] | None = None, detection_height_difference_for_dual_lld: List[int] | None = None, swap_speed: List[int] | None = None, settling_time: List[int] | None = None, homogenization_volume: List[int] | None = None, homogenization_cycles: List[int] | None = None, homogenization_position_from_liquid_surface: List[int] | None = None, homogenization_speed: List[int] | None = None, homogenization_surface_following_distance: List[int] | None = None, limit_curve_index: List[int] | None = None, use_2nd_section_aspiration: List[bool] | None = None, retract_height_over_2nd_section_to_empty_tip: List[int] | None = None, dispensation_speed_during_emptying_tip: List[int] | None = None, dosing_drive_speed_during_2nd_section_search: List[int] | None = None, z_drive_speed_during_2nd_section_search: List[int] | None = None, cup_upper_edge: List[int] | None = None, ratio_liquid_rise_to_tip_deep_in: List[int] | None = None, immersion_depth_2nd_section: List[int] | None = None, minimum_traverse_height_at_beginning_of_a_command: int | None = None, min_z_endpos: int | None = None, hamilton_liquid_classes: List[HamiltonLiquidClass | None] | None = None)#

Aspirate liquid from the specified channels.

For all parameters where None is the default value, STAR will use the default value, based on the aspirations. For all list parameters, the length of the list must be equal to the number of operations.

Warning

The parameters in this method, with the exception of ops and use_channels, expect units of tenths of ‘millimeters’ (i.e. 10 = 1 mm), or tenths of ‘microliters’ (i.e. 10 = 1 ul), or tenths of seconds. Speeds are in 0.1ul/s. This is a deviation from the rest of the API, which uses SI units. This is because the Hamilton API uses these units.

Parameters:

  • ops (List[Aspiration]) – The aspiration operations to perform.

  • use_channels (List[int]) – The channels to use for the operations.

  • jet (List[bool] | None) – whether to search for a jet liquid class. Only used on dispense. Default is False.

  • blow_out (List[bool] | None) – whether to blow out air. Only used on dispense. Note that in the VENUS Liquid Editor, this is called “empty”. Default is False.

  • lld_search_height (List[int] | None) – The height to start searching for the liquid level when using LLD.

  • clot_detection_height (List[int] | None) – Unknown, but probably the height to search for clots when doing LLD.

  • pull_out_distance_transport_air (List[int] | None) – The distance to pull out when aspirating air, if LLD is disabled.

  • second_section_height (List[int] | None) – The height to start the second section of aspiration.

  • second_section_ratio (List[int] | None) – Unknown.

  • minimum_height (List[int] | None) – The minimum height to move to, this is the end of aspiration. The channel will move linearly from the liquid surface to this height over the course of the aspiration.

  • immersion_depth (List[int] | None) – The z distance to move after detecting the liquid, can be into or away from the liquid surface (dependent on immersion_depth_direction).

  • immersion_depth_direction (List[int] | None) – set to 0, tip will move below the detected liquid surface; set to 1, tip will move away from the detected surface.

  • surface_following_distance (List[int] | None) – The distance to follow the liquid surface.

  • transport_air_volume (List[int] | None) – The volume of air to aspirate after the liquid.

  • pre_wetting_volume (List[int] | None) – The volume of liquid to use for pre-wetting.

  • lld_mode (List[LLDMode] | None) – The liquid level detection mode to use.

  • gamma_lld_sensitivity (List[int] | None) – The sensitivity of the gamma LLD.

  • dp_lld_sensitivity (List[int] | None) – The sensitivity of the DP LLD.

  • aspirate_position_above_z_touch_off (List[int] | None) – If the LLD mode is Z_TOUCH_OFF, this is the height above the bottom of the well (presumably) to aspirate from.

  • detection_height_difference_for_dual_lld (List[int] | None) – Difference between the gamma and DP LLD heights if the LLD mode is DUAL.

  • swap_speed (List[int] | None) – Unknown.

  • settling_time (List[int] | None) – The time to wait after homogenization.

  • homogenization_volume (List[int] | None) – The volume to aspirate for homogenization.

  • homogenization_cycles (List[int] | None) – The number of cycles to perform for homogenization.

  • homogenization_position_from_liquid_surface (List[int] | None) – The height to aspirate from for homogenization (LLD or absolute terms).

  • homogenization_speed (List[int] | None) – The speed to aspirate at for homogenization.

  • homogenization_surface_following_distance (List[int] | None) – The distance to follow the liquid surface for homogenization.

  • limit_curve_index (List[int] | None) – The index of the limit curve to use.

  • use_2nd_section_aspiration (List[bool] | None) – Whether to use the second section of aspiration.

  • retract_height_over_2nd_section_to_empty_tip (List[int] | None) – Unknown.

  • dispensation_speed_during_emptying_tip (List[int] | None) – Unknown.

  • dosing_drive_speed_during_2nd_section_search (List[int] | None) – Unknown.

  • z_drive_speed_during_2nd_section_search (List[int] | None) – Unknown.

  • cup_upper_edge (List[int] | None) – Unknown.

  • ratio_liquid_rise_to_tip_deep_in (List[int] | None) – Unknown.

  • immersion_depth_2nd_section (List[int] | None) – The depth to move into the liquid for the second section of aspiration.

  • minimum_traverse_height_at_beginning_of_a_command (int | None) – The minimum height to move to before starting an aspiration.

  • min_z_endpos (int | None) – The minimum height to move to, this is the end of aspiration.

  • hamilton_liquid_classes (List[HamiltonLiquidClass | None] | None) – Override the default liquid classes. See pylabrobot/liquid_handling/liquid_classes/hamilton/star.py

Contents