Magnetic Bead Separation Helper Functions

get_mag_amplicenter

autoprotocol_utilities.magnetic_helpers.get_mag_amplicenter(plate, amplitude_fraction=1.0)[source]

Determine amplitude and center for KF operations

Given the container this function determines the well type and fill volume. From that it calculates the center for the magnetic operation (1/2 the fill volume) and the amplitude to move around that from 0 to center + amplitude.

Example Usage:

from autoprotocol import Protocol
from autoprotocol_utilities.magnetic_helpers import get_mag_amplicenter

p = Protocol()
example_plate = p.ref(name="Example", id=None, cont_type="96-pcr",
                      storage="ambient")
p.dispense(ref=example_plate, reagent="water",
           columns=[{"column": 4, "volume": "100:microliters"},])

get_mag_amplicenter(example_plate)

Returns:

{'center': 0.3125, 'amplitude': 0.3125}
Parameters:
  • plate (Container) – Plate that is being used
  • amplitude_fraction (float, optional) – By default the full available amplitude will be used (from center to bottom of well). Use this parameter to reduce the amplitude.
Returns:

center and amplitude both of type float
Return type:

nametuple
Raises:
  • ValueError – If plate is not of type Container
  • ValueError – If amplitude_fraction is not a float or bigger than 1

get_mag_frequency

autoprotocol_utilities.magnetic_helpers.get_mag_frequency(plate, speed)[source]

Determine frequency for KF operation

Based on plate type and the desired KF speed, determine the frequency for the KF operation. Needed for mix and release operations.

Example Usage:

from autoprotocol import Protocol
from autoprotocol_utilities.magnetic_helpers import get_mag_frequency

p = Protocol()
example_plate = p.ref(name="Example", id=None, cont_type="96-pcr",
                      storage="ambient")
get_mag_frequency(plate=example_plate, speed="slow")

Returns:

0.4:hertz
Parameters:
  • plate (Container) – Container that is being used
  • speed (string) – String defining the speed - can be slow, medium, fast
Returns:

Frequency in the form of “2.5:Hz”
Return type:

string
Raises:
  • ValueError – If plate is not of type Container
  • ValueError – If speed is not ‘slow’, ‘medium’, ‘fast’
  • ValueError – If plate type is not a key in frequencies