ecl-logo Documentation
ECL`

Pellet

Pellet[Options]⟹UnitOperation

precipitate solids that are present in a solution, aspirate off the supernatant, and optionally resuspend the pellet in a resuspension solution.

    
Pellet is the primitive that used to precipitate solids that are present in a solution, optionally aspirate off the supernatant, and resuspend the resulting pellet.
    

Experimental Principles

    Figure 1.1: Figure 1.1: Procedural overview of a Pelleting experiment. Step 1: The SamplesIn are prepared according to any sample preparation options that are set. This may include any aliquots needed to get the SamplesIn into a centrifuge compatible container. Step 2: The samples are centrifuged in order to form a pellet. Step 3: (Optional) The supernatant is aspirated from the pelleted sample. Step 4: (Optional) The pellet is resuspended using the specified ResuspensionSource and mixed.

Instrumentation

    Avanti J-15R

    Figure 2.1: Samples to be centrifuged are counterbalanced in available centrifuge bucket slots. The centrifuge spins the buckets around the axis of the main rotor, while applying optional heating or cooling. As the samples spin, they are exposed to a centrifugal force that is significantly larger than typical gravitational acceleration. The samples can subsequently be collected at the end of the experiment.

    Avanti J-15R with JA-10.100 Fixed Angle Rotor

    Figure 2.2: Samples to be centrifuged are counterbalanced in available centrifuge rotor slots. The centrifuge spins the rotors around the axis of the main rotor, while applying optional heating or cooling. As the samples spin, they are exposed to a centrifugal force that is significantly larger than typical gravitational acceleration. The samples can subsequently be collected at the end of the experiment.

    Microfuge 16

    Figure 2.3: Samples to be centrifuged are counterbalanced in available centrifuge slots. The centrifuge spins the samples around the axis of the rotor. As the samples spin, they are exposed to a centrifugal force that is significantly larger than typical gravitational acceleration. The samples can subsequently be collected at the end of the experiment.

    Beckman Coulter Microfuge 20R

    Figure 2.4: Samples to be centrifuged are counterbalanced in available centrifuge bucket slots. The centrifuge spins the buckets around the axis of the main rotor, while applying optional heating or cooling. As the samples spin, they are exposed to a centrifugal force that is significantly larger than typical gravitational acceleration. The samples can subsequently be collected at the end of the experiment.

    Eppendorf 5920R

    Figure 2.5: Samples to be centrifuged are counterbalanced in available centrifuge bucket slots. The centrifuge spins the buckets around the axis of the main rotor, while applying optional cooling to prevent a buildup of heat caused by the friction of spinning the rotor. As the samples spin, they are exposed to a centrifugal force that is significantly larger than typical gravitational acceleration. The samples can subsequently be collected at the end of the experiment.

Experiment Options

    General

    Sample

    The samples that should be pelleted.
    Default Value: Null
    Pattern Description: Container with Well Position or Model Sample or Sample or Container or Null.
    Programmatic Pattern: (ObjectP[{Object[Sample], Object[Container]}] | _String) | {Alternatives @@ Flatten[AllWells[NumberOfWells -> 384]] | LocationPositionP, ObjectP[{Object[Container]}] | _String} | ObjectP[Model[Sample]]
    Index Matches to: Sample

    SampleLabel

    A user defined word or phrase used to identify the samples whose denser or insoluble contents will be concentrated to the bottom of a given container, for use in downstream unit operations.
    Default Value: Automatic
    Pattern Description: A string.
    Programmatic Pattern: _String | Automatic
    Index Matches to: Sample

    SampleContainerLabel

    A user defined word or phrase used to identify the containers of the samples whose denser or insoluble contents will be concentrated to the bottom of a given container, for use in downstream unit operations.
    Default Value: Automatic
    Pattern Description: A string.
    Programmatic Pattern: _String | Automatic
    Index Matches to: Sample

    SampleOutLabel

    A user defined word or phrase used to identify the samples transferred into SupernatantDestinations, for use in downstream unit operations. If SupernatantDestination is set to Waste, SampleOutLabel should be Null as the sample out cannot be labeled for further use.
    Default Value: Automatic
    Pattern Description: A string or Null.
    Programmatic Pattern: ((Null | _String) | Automatic) | Null
    Index Matches to: Sample

    ContainerOutLabel

    A user defined word or phrase used to identify the containers of the samples transferred into SupernatantDestinations, for use in downstream unit operations. If SupernatantDestination is set to Waste, ContainerOutLabel should be Null as the waste container cannot be labeled for further use.
    Default Value: Automatic
    Pattern Description: A string or Null.
    Programmatic Pattern: ((Null | _String) | Automatic) | Null
    Index Matches to: Sample

    Preparation

    Indicates if this unit operation is carried out primarily robotically or manually. Manual unit operations are executed by a laboratory operator and robotic unit operations are executed by a liquid handling work cell.
    Default Value: Automatic
    Pattern Description: Manual or Robotic.
    Programmatic Pattern: PreparationMethodP | Automatic

    WorkCell

    The automated workstation with a collection of integrated instruments on which this unit operation will be will be performed if Preparation -> Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to STAR if Preparation->Robotic.
    Pattern Description: STAR, bioSTAR, or microbioSTAR or Null.
    Programmatic Pattern: ((STAR | bioSTAR | microbioSTAR) | Automatic) | Null

    Centrifugation

    Instrument

    The centrifuge that will be used to spin the provided samples.
    Default Value: Automatic
    Default Calculation: Automatically set to a centrifuge that can attain the specified intensity, time, temperature, and sterility and (if possible) that is compatible with the sample in its current container.
    Pattern Description: An object of type or subtype Model[Instrument, Centrifuge] or Object[Instrument, Centrifuge]
    Programmatic Pattern: ObjectP[{Model[Instrument, Centrifuge], Object[Instrument, Centrifuge]}] | Automatic
    Index Matches to: Sample

    Intensity

    The rotational speed or the force that will be applied to the samples by centrifugation in order to create a pellet.
    Default Value: Automatic
    Default Calculation: Automatically set to one fifth of the maximum rotational rate of the centrifuge, rounded to the nearest attainable centrifuge precision.
    Pattern Description: Greater than or equal to 0 revolutions per minute and less than or equal to 80000 revolutions per minute or greater than or equal to 0 standard accelerations due to gravity on the surface of the earth and less than or equal to 504000 standard accelerations due to gravity on the surface of the earth.
    Programmatic Pattern: (RangeP[0*RPM, $MaxCentrifugeSpeed] | RangeP[0*GravitationalAcceleration, $MaxRelativeCentrifugalForce]) | Automatic
    Index Matches to: Sample

    Time

    The amount of time that the samples will be centrifuged.
    Default Value: 5 minutes
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours.
    Programmatic Pattern: RangeP[0*Minute, $MaxExperimentTime]
    Index Matches to: Sample

    Temperature

    The temperature at which the centrifuge chamber will be held while the samples are being centrifuged.
    Default Value: Ambient
    Pattern Description: Ambient or greater than or equal to -10 degrees Celsius and less than or equal to 40 degrees Celsius.
    Programmatic Pattern: Ambient | RangeP[-10*Celsius, 40*Celsius]
    Index Matches to: Sample

    Supernatant Aspiration

    SupernatantVolume

    The volume of supernatant that will be aspirated from the source sample.
    Default Value: Automatic
    Default Calculation: Automatically set based on Preparation: All for Preparation is Manual and half of the sample volume for Preparation is Robotic.
    Pattern Description: All or Volume.
    Programmatic Pattern: (All | RangeP[1*Microliter, 20*Liter]) | Automatic
    Index Matches to: Sample

    SupernatantDestination

    The destination that the supernatant should be dispensed into, after aspirated from the source sample.
    Default Value: Automatic
    Default Calculation: SupernatantDestination is set to Waste if performing the aspiration manually using an aspirator. Otherwise, SupernatantDestination is set to an empty liquid handler container to dispense the supernatant into.
    Pattern Description: Destination Sample/Container or Waste.
    Programmatic Pattern: (Waste | (ObjectP[{Object[Sample], Object[Container], Model[Container]}] | _String)) | Automatic
    Index Matches to: Sample

    Resuspension

    Resuspension

    Indicates if the pellet should be resuspended after the supernatant is aspirated.
    Default Value: Automatic
    Default Calculation: Automatically set to True if any of the other resuspension options are set.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

    ResuspensionSource

    The sample that should be used to resuspend the pellet from the source sample.
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Sample, "Milli-Q water"] if any of the other Resuspension options are set.
    Pattern Description: An object of type or subtype Model[Sample], Object[Sample], or Object[Container] or a prepared sample or Null.
    Programmatic Pattern: ((Null | (ObjectP[{Model[Sample], Object[Sample], Object[Container]}] | _String)) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionSourceLabel

    The label of the samples that should be used to resuspend the pellet from the source sample, which is used for identification elsewhere in sample preparation.
    Default Value: Automatic
    Pattern Description: A string or Null.
    Programmatic Pattern: ((Null | _String) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionVolume

    The volume of ResuspensionSource that should be used to resuspend the pellet from the source sample.
    Default Value: Automatic
    Default Calculation: Automatically set to 1/4 of the source sample container's volume or the volume of the provided ResuspensionSource (whichever is smaller), if any of the other Resuspension options are set.
    Pattern Description: All or Volume or Null.
    Programmatic Pattern: ((Null | (All | RangeP[1*Microliter, 20*Liter])) | Automatic) | Null
    Index Matches to: Sample

    Resuspension Mix

    ResuspensionMix

    Indicates if this sample is mixed.
    Default Value: Automatic
    Default Calculation: Automatically set to True if any Mix related options are set. Otherwise, set to False.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixType

    Indicates the style of motion used to mix the sample. Options include Roll, Vortex, Sonicate, Pipette, Invert, Stir, Shake, Homogenize, Swirl, Disrupt, Nutate.
    Default Value: Automatic
    Default Calculation: Automatically sets based on the container of the sample and the Mix option. Specifically, if Mix is set to False, the option is set to Null. If MixInstrument is specified, the option is set based on the type of the Model[Instrument] or Object[Instrument] of the specified MixInstrument. If MixRate and Time are Null, when MixVolume is Null or larger than 50ml, the option is set to Invert, otherwise set to Pipette. If Amplitude, MaxTemperature, or DutyCycle is not Null, the option is set to Homogenizer. If MixRate is set, the option is set based on the type of the Model[Instrument] of the first instrument found by MixDevices that is compatible with the SamplesIn, Temperature, and MixRate.
    Pattern Description: Roll, Vortex, Sonicate, Pipette, Invert, Stir, Shake, Homogenize, Swirl, Disrupt, or Nutate or Null.
    Programmatic Pattern: ((Null | MixTypeP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixUntilDissolved

    Indicates if the mix should be continued up to the MaxTime or MaxNumberOfMixes (chosen according to the mix Type), in an attempt dissolve any solute.
    Default Value: Automatic
    Default Calculation: Automatically set to True if MaxTime or MaxNumberOfMixes is set.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixInstrument

    The instrument used to perform the Mix and/or Incubation.
    Default Value: Automatic
    Default Calculation: Automatically resolves based on the options Mix, Temperature, MixType and container of the sample.
    Pattern Description: An object of type or subtype Model[Instrument, Roller], Model[Instrument, OverheadStirrer], Model[Instrument, Vortex], Model[Instrument, Shaker], Model[Instrument, BottleRoller], Model[Instrument, Roller], Model[Instrument, Sonicator], Model[Instrument, HeatBlock], Model[Instrument, Homogenizer], Model[Instrument, Disruptor], Model[Instrument, Nutator], Model[Instrument, Thermocycler], Model[Instrument, EnvironmentalChamber], Model[Instrument, Pipette], Object[Instrument, Roller], Object[Instrument, OverheadStirrer], Object[Instrument, Vortex], Object[Instrument, Shaker], Object[Instrument, BottleRoller], Object[Instrument, Roller], Object[Instrument, Sonicator], Object[Instrument, HeatBlock], Object[Instrument, Homogenizer], Object[Instrument, Disruptor], Object[Instrument, Nutator], Object[Instrument, Thermocycler], Object[Instrument, EnvironmentalChamber], or Object[Instrument, Pipette] or Null.
    Programmatic Pattern: ((Null | ObjectP[Join[MixInstrumentModels, MixInstrumentObjects]]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixStirBar

    The stir bar that is used to stir the sample.
    Default Value: Automatic
    Default Calculation: If MixRate is above 1000 RPM, or if no compatible impeller can be found for the given stirrer, StirBar is automatically set to the largest compatible stir bar found. Here, a compatible impeller means that it can fit in the aperture of the sample's container, can reach the bottom of the sample's container, and is compatible with the stir instrument given; a compatible stir bar means that its width can fit in the aperture of the sample's container and that its length is not greater than the InternalDiameter of the sample's container. Otherwise set to Null.
    Pattern Description: An object of type or subtype Model[Part, StirBar] or Object[Part, StirBar] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Part, StirBar], Object[Part, StirBar]}]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTime

    Duration of time for which the samples will be mixed.
    Default Value: Automatic
    Default Calculation: Automatically set to 5 Minute for robotic preparation. For manual preparation, if Thaw is True, set to 0 Minute; else if MaxTime is specified, Time is automatically set to 1/3 of MaxTime; otherwise set to 15 Minute. As a special case in manual preparation, when LightExposure is not Null, Thaw is True, set to 0 Minute; else if TotalLightExposure is specified and LightExposureIntensity is not Null, Time is automatically set to TotalLightExposure/LightExposureIntensity; otherwise set to 1 Hour.
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours or Null.
    Programmatic Pattern: ((Null | RangeP[0*Minute, $MaxExperimentTime]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixMaxTime

    Maximum duration of time for which the samples are mixed, in an attempt to dissolve any solute, if the MixUntilDissolved option is chosen. Note this option only applies for mix type: Shake, Roll, Vortex or Sonicate.
    Default Value: Automatic
    Default Calculation: Automatically set to 5 Hour if MixUntilDissolved is True, when an applicable MixType is chosen, otherwise set to Null.
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours or Null.
    Programmatic Pattern: ((Null | RangeP[0*Minute, $MaxExperimentTime]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixDutyCycle

    The style how the homogenizer mixes the given sample via pulsation of the sonication horn. This duty cycle is repeated indefinitely until the specified Time/MaxTime has elapsed. This option can only be set when mixing via homogenization.
    Default Value: Automatic
    Default Calculation: Automatically set to {10 Millisecond, 10 Millisecond} if mixing by homogenization.
    Pattern Description: {Time On, Time Off} or Null.
    Programmatic Pattern: ((Null | {RangeP[0*Minute, 60*Hour], RangeP[0*Minute, 60*Hour]}) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixRate

    The frequency of rotation used by the mixing instrument to mix the samples.
    Default Value: Automatic
    Default Calculation: Automatically set to 300 RPM for robotic preparation. For manual preparation, MixRate is set to 20% of the MaxRotationRate if MixType is Stir, or otherwise is set to the average of MinRotationRate and MaxRotationRate of the instrument.
    Pattern Description: Gravitational Acceleration (Acoustic Shaker Only) or RPM or Null.
    Programmatic Pattern: ((Null | (RangeP[$MinMixRate, $MaxMixRate] | RangeP[0*GravitationalAcceleration, 100*GravitationalAcceleration])) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixRateProfile

    The frequency of rotation of the mixing instrument used to mix the samples, over the course of time.
    Default Value: Automatic
    Pattern Description: List of one or more {Time, MixRate} entries or Null.
    Programmatic Pattern: ((Null | {{RangeP[0*Minute, $MaxExperimentTime], RangeP[$MinMixRate, $MaxMixRate] | RangeP[0*GravitationalAcceleration, 100*GravitationalAcceleration]}..}) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionNumberOfMixes

    The number of times the samples are mixed if MixType of Pipette or Invert is chosen.
    Default Value: Automatic
    Default Calculation: If MaxNumberOfMixes is specified, automatically set to 1/3 of MaxNumberOfMixes (round to integer); else if MixUntilDissolved->True, automatically set to 25; otherwise set to 15.
    Pattern Description: Greater than or equal to 1 and less than or equal to 50 in increments of 1 or Null.
    Programmatic Pattern: ((Null | RangeP[1, 50, 1]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMaxNumberOfMixes

    The maximum number of times for which the samples are mixed, in an attempt to dissolve any solute, if the MixUntilDissolved option is chosen. Note this option only applies for mix type: Pipette or Invert.
    Default Value: Automatic
    Default Calculation: When MixUntilDissolved->True, automatically set to 2*NumberOfMixes if it is Numeric (specified or automatically set); if not, set to 50.
    Pattern Description: Greater than or equal to 1 and less than or equal to 250 in increments of 1 or Null.
    Programmatic Pattern: ((Null | RangeP[1, 250, 1]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixVolume

    The volume of the sample that is pipetted up and down to mix if MixType->Pipette.
    Default Value: Automatic
    Default Calculation: For robotic preparation, automatically set to 970 Microliter or sample volume informed by the field Volume of the sample, whichever is smaller. For manual preparation, automatically set to 50 Milliliter or half of the sample volume informed by the field Volume of the sample, whichever is smaller.
    Pattern Description: Greater than or equal to 0.5 microliters and less than or equal to 50 milliliters or Null.
    Programmatic Pattern: ((Null | RangeP[0.5*Microliter, 50*Milliliter]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTemperature

    The temperature of the device that is used to mix/incubate the sample. If mixing via homogenization, the pulse duty cycle of the sonication horn is automatically adjusted if the measured temperature of the sample exceeds this set temperature.
    Default Value: Automatic
    Default Calculation: Automatically set to 40 Celsius if AnnealingTime is specified, if not, set to Ambient.
    Pattern Description: Ambient or greater than or equal to -20 degrees Celsius and less than or equal to 500 degrees Celsius or Null.
    Programmatic Pattern: ((Null | (RangeP[$MinIncubationTemperature, $MaxIncubationTemperature] | Ambient)) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTemperatureProfile

    The temperature of the device, over the course of time, that is used to mix/incubate the sample.
    Default Value: Automatic
    Pattern Description: List of one or more {Time, Temperature} entries or Null.
    Programmatic Pattern: ((Null | {{RangeP[0*Minute, $MaxExperimentTime], RangeP[$MinTemperatureProfileTemperature, $MaxTemperatureProfileTemperature]}..}) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixMaxTemperature

    The maximum temperature that the sample is allowed to reach during mixing via homogenization or sonication. If the measured temperature is above this MaxTemperature, the homogenizer/sonicator turns off until the measured temperature is 2C below the MaxTemperature, then it automatically resumes.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 0 degrees Celsius and less than or equal to 100 degrees Celsius or Null.
    Programmatic Pattern: ((Null | RangeP[0*Celsius, 100*Celsius]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixOscillationAngle

    The angle of oscillation of the mixing motion when a wrist action shaker is used.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 0 degrees and less than or equal to 15 degrees or Null.
    Programmatic Pattern: ((Null | RangeP[0*AngularDegree, 15*AngularDegree]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixAmplitude

    The amplitude of the sonication horn when mixing via homogenization. When using a microtip horn (ex. for 2mL and 15mL tubes), the maximum amplitude is 70 Percent, as specified by the manufacturer, in order not to damage the instrument.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 10 percent and less than or equal to 100 percent or Null.
    Programmatic Pattern: ((Null | RangeP[10*Percent, 100*Percent]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixFlowRate

    The speed at which liquid is aspirated and dispensed in a liquid before it is aspirated. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to 100 Microliter/Second when mixing by pipetting if Preparation->Robotic.
    Pattern Description: MixFlowRate speed at which liquid should be drawn up into the pipette tip or Null.
    Programmatic Pattern: ((Null | RangeP[0.4*(Microliter/Second), 500*(Microliter/Second)]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixPosition

    The location from which liquid should be mixed by pipetting. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to LiquidLevel if MixType->Pipette and Preparation->Robotic.
    Pattern Description: MixPosition location from which liquid should be aspirated or Null.
    Programmatic Pattern: ((Null | PipettingPositionP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixPositionOffset

    The distance from the center of the well that liquid will aspirated/dispensed while mixing the sample. When specifying a Z Offset, the Z Offset is calculated either as the height below the top of the well, the height above the bottom of the well, or the height below the detected liquid level, depending on value of the AspirationPosition option (Top|Bottom|LiquidLevel). When an AspirationAngle is specified, the AspirationPositionOffset is measured in the frame of reference of the tilted labware (so that wells that are further away from the pivot point of the tilt are in the same frame of reference as wells that are close to the pivot point of the tilt). This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to 2 Millimeter if MixType->Pipette and Preparation->Robotic.
    Pattern Description: {X,Y,Z} Coordinate Offset or Z Offset or Null.
    Programmatic Pattern: ((Null | (GreaterEqualP[0*Millimeter] | Coordinate[{DistanceP, DistanceP, GreaterEqualP[0*Millimeter]}])) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixCorrectionCurve

    The relationship between a target volume and the corrected volume that needs to be aspirated or dispensed to reach the target volume. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to correction curve set in the PipettingMethod for the Object[Sample] if MixType->Pipette and Preparation->Robotic.
    Pattern Description: List of one or more {Target Volume, Actual Volume} entries or Null.
    Programmatic Pattern: ((Null | {{RangeP[0*Microliter, 1000*Microliter], RangeP[0*Microliter, 1250*Microliter]}..}) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTips

    The pipette tips used to aspirate and dispense the requested volume..
    Default Value: Automatic
    Default Calculation: If MixType->Pipette, automatically set to the preferred tips determined by TransferDevices with given MixVolume, as well as TipType and TipMaterial if specified, and it is also checked that the tips can reach the bottom of the container.
    Pattern Description: An object of type or subtype Model[Item, Tips] or Object[Item, Tips] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Item, Tips], Object[Item, Tips]}]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTipType

    The tip type to use to mix liquid in the manipulation.
    Default Value: Automatic
    Default Calculation: If Tips is specified, automatically set to the field TipType of the Model[Item, Tips] or the Model of Object[Item,Tips]. Otherwise, set to Null.
    Pattern Description: Normal, Barrier, WideBore, GelLoading, or Aspirator or Null.
    Programmatic Pattern: ((Null | TipTypeP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixTipMaterial

    The material of the pipette tips used to aspirate and dispense the requested volume during the transfer.
    Default Value: Automatic
    Default Calculation: If Tips is specified, automatically set to the field Material of the Model[Item, Tips] or the Model of Object[Item,Tips]. Otherwise, set to Null.
    Pattern Description: {ABS, PLA, Acrylic, AmorphousFluoropolymer, CPVC, CTFE, Cycloolefine, COC, Delrin, ECTFE, EPDM, ETFE, EVA, FEP, FFKM, HDPE, Hypalon, LDPE, NaturalRubber, NBR, Neoprene, Nitrile, Noryl, Nylon, PEEK, PEI, Perlast, PharmaPure, Polycarbonate, Polyester, Polyethylene, Polyisoprene, Polyolefin, Polyoxymethylene, Polypropylene, Polysulfone, Polystyrene, Polyurethane, PVC, PCTFE, PETG, PF, PFA, PPS, PTFE, PVDF, SEBS, Silicone, Styrofoam, SyntheticRubber, TFM, TPE, Tygon, UVPlastic, UVXPO, Viton}, {Aluminum, Alloy, AnodisedAluminum, Brass, Bronze, CarbonSteel, CastIron, Chrome, Copper, Elgiloy, Gold, Hastelloy, Lead, Magnesium, Molybdenum, MP35N, MP35NHPS, Nickel, Niobium, Platinum, Silver, Steel, StainlessSteel, Titanium, Tungsten, Zinc}, {Cellulose, Cotton, Polyethylene, Polypropylene, PTFE, Nylon, PES, PLUS, PVDF, GlassFiber, GHP, UHMWPE, EPDM, DuraporePVDF, GxF, ZebaDesaltingResin, NickelResin, AgaroseResin, CobaltResin, Silica, HLB, AnoporeAlumina}, {Silica, Alumina, ResinParticlesWithLatexMicroBeads, CrossLinkedDextranBeads, CrossLinkedPolystyrene, AerisCoreShell, KinetexCoreShell, CrossLinkedAgarose, Vydac218MS, JordiGel, Styrene, SilicaCompositeTWIN, BEH, CSH, HSS, CarboPacPA1, CarboPacPA10, BEH}, AluminiumOxide, ZirconiumOxide, Ceramic, Epoxy, EpoxyResin, GlassyCarbon, {BorosilicateGlass, Glass, OpticalGlass}, Graphite, Porcelain, Oxidizer, {Cardboard, Wood}, {Agate, Quartz, UVQuartz, ESQuartz, FusedQuartz, IRQuartz}, Ruby, Sapphire, Silicon, Viton, or {VacuumMeltedStainlessSteel} or Null.
    Programmatic Pattern: ((Null | MaterialP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixMultichannelMix

    Indicates if multiple device channels should be used when performing pipette mixing.
    Default Value: Automatic
    Default Calculation: Automatically set to True if there are multiple samples that are mixed via pipette, if MixType->Pipette.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixDeviceChannel

    The channel of the work cell that should be used to perform the pipetting mixing. This option can only be set if Preparation->Robotic and MixType->Pipette.
    Default Value: Automatic
    Default Calculation: Automatically set to SingleProbe1 if MultichannelMix->False. Otherwise, set to the appropriate channel to perform the transfer, if Preparation->Robotic and MixType->Pipette.
    Pattern Description: MultiProbeHead, SingleProbe1, SingleProbe2, SingleProbe3, SingleProbe4, SingleProbe5, SingleProbe6, SingleProbe7, or SingleProbe8 or Null.
    Programmatic Pattern: ((Null | DeviceChannelP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixResidualIncubation

    Indicates if the incubation and/or mixing should continue after Time/MaxTime has finished while waiting to progress to the next step in the protocol.
    Default Value: Automatic
    Default Calculation: Automatically set to True if Temperature is non-Ambient and the samples being incubated have non-ambient TransportTemperature.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixResidualTemperature

    The temperature at which the sample(s) should remain incubating after Time has elapsed. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to Temperature if ResidualIncubation is True and Preparation->Robotic.
    Pattern Description: Ambient or Null or greater than or equal to 0 degrees Celsius and less than or equal to 105 degrees Celsius.
    Programmatic Pattern: ((RangeP[0*Celsius, 105*Celsius] | (Ambient | Null)) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixResidualMix

    Indicates that the sample(s) should remain shaking at the ResidualMixRate after Time has elapsed. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to False if Preparation->Robotic.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixResidualMixRate

    When mixing by shaking, this is the rate at which the sample(s) remains shaking after Time has elapsed. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to MixRate if ResidualMix is True and Preparation->Robotic.
    Pattern Description: Greater than or equal to 30 revolutions per minute and less than or equal to 2500 revolutions per minute or Null.
    Programmatic Pattern: ((Null | RangeP[30*RPM, 2500*RPM]) | Automatic) | Null
    Index Matches to: Sample

    ResuspensionMixPreheat

    Indicates if the incubation position is brought to Temperature before exposing the Sample to it. This option can only be set if Preparation->Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to False if Preparation->Robotic.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    Post Experiment

    SamplesInStorageCondition

    The non-default conditions under which the SamplesIn of this experiment should be stored after the protocol is completed. If left unset, SamplesIn will be stored according to their current StorageCondition.
    Default Value: Null
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
    Programmatic Pattern: (Null | (Alternatives[SampleStorageTypeP | Disposal])) | Null
    Index Matches to: Sample

    SamplesOutStorageCondition

    The non-default conditions under which any new samples generated by this experiment should be stored after the protocol is completed. If left unset, the new samples will be stored according to their Models' DefaultStorageCondition.
    Default Value: Null
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
    Programmatic Pattern: (Null | (Alternatives[SampleStorageTypeP | Disposal])) | Null
    Index Matches to: Sample

    Transfer Technique

    SterileTechnique

    Indicates if sterilized instruments and aseptic transfer environments must be used for the transfer. Aseptic transfer environments include biosafety cabinets as TransferEnvironment, or bioSTAR and microbioSTAR Hamilton enclosures as WorkCell. Please consult the ExperimentTransfer documentation for a full diagram of SterileTechnique that is employed by operators.
    Default Value: Automatic
    Default Calculation: Automatically set to True if the samples being transferred contain tissue culture or microbial components, or require aseptic techniques.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

Sample Prep Options

    Preparatory Incubation

    Incubate

    Indicates if the SamplesIn should be incubated at a fixed temperature prior to starting the experiment or any aliquoting. Sample Preparation occurs in the order of Incubation, Centrifugation, Filtration, and then Aliquoting (if specified).
    Default Value: Automatic
    Default Calculation: Resolves to True if any of the corresponding Incubation options are set. Otherwise, resolves to False.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

    IncubationTemperature

    Temperature at which the SamplesIn should be incubated for the duration of the IncubationTime prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Ambient or greater than or equal to -20 degrees Celsius and less than or equal to 500 degrees Celsius or Null.
    Programmatic Pattern: ((Null | (Ambient | RangeP[$MinIncubationTemperature, $MaxIncubationTemperature])) | Automatic) | Null
    Index Matches to: Sample

    IncubationTime

    Duration for which SamplesIn should be incubated at the IncubationTemperature, prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 1 minute and less than or equal to 72 hours or Null.
    Programmatic Pattern: ((Null | RangeP[1*Minute, $MaxExperimentTime]) | Automatic) | Null
    Index Matches to: Sample

    Mix

    Indicates if this sample should be mixed while incubated, prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Automatically resolves to True if any Mix related options are set. Otherwise, resolves to False.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    MixType

    Indicates the style of motion used to mix the sample, prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Automatically resolves based on the container of the sample and the Mix option.
    Pattern Description: Roll, Vortex, Sonicate, Pipette, Invert, Stir, Shake, Homogenize, Swirl, Disrupt, or Nutate or Null.
    Programmatic Pattern: ((Null | MixTypeP) | Automatic) | Null
    Index Matches to: Sample

    MixUntilDissolved

    Indicates if the mix should be continued up to the MaxIncubationTime or MaxNumberOfMixes (chosen according to the mix Type), in an attempt dissolve any solute. Any mixing/incubation will occur prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Automatically resolves to True if MaxIncubationTime or MaxNumberOfMixes is set.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    MaxIncubationTime

    Maximum duration of time for which the samples will be mixed while incubated in an attempt to dissolve any solute, if the MixUntilDissolved option is chosen. This occurs prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Automatically resolves based on MixType, MixUntilDissolved, and the container of the given sample.
    Pattern Description: Greater than or equal to 1 minute and less than or equal to 72 hours or Null.
    Programmatic Pattern: ((Null | RangeP[1*Minute, $MaxExperimentTime]) | Automatic) | Null
    Index Matches to: Sample

    IncubationInstrument

    The instrument used to perform the Mix and/or Incubation, prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Automatically resolves based on the options Mix, Temperature, MixType and container of the sample.
    Pattern Description: An object of type or subtype Model[Instrument, Roller], Model[Instrument, OverheadStirrer], Model[Instrument, Vortex], Model[Instrument, Shaker], Model[Instrument, BottleRoller], Model[Instrument, Roller], Model[Instrument, Sonicator], Model[Instrument, HeatBlock], Model[Instrument, Homogenizer], Model[Instrument, Disruptor], Model[Instrument, Nutator], Model[Instrument, Thermocycler], Model[Instrument, EnvironmentalChamber], Model[Instrument, Pipette], Object[Instrument, Roller], Object[Instrument, OverheadStirrer], Object[Instrument, Vortex], Object[Instrument, Shaker], Object[Instrument, BottleRoller], Object[Instrument, Roller], Object[Instrument, Sonicator], Object[Instrument, HeatBlock], Object[Instrument, Homogenizer], Object[Instrument, Disruptor], Object[Instrument, Nutator], Object[Instrument, Thermocycler], Object[Instrument, EnvironmentalChamber], or Object[Instrument, Pipette] or Null.
    Programmatic Pattern: ((Null | ObjectP[Join[MixInstrumentModels, MixInstrumentObjects]]) | Automatic) | Null
    Index Matches to: Sample

    AnnealingTime

    Minimum duration for which the SamplesIn should remain in the incubator allowing the system to settle to room temperature after the IncubationTime has passed but prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours or Null.
    Programmatic Pattern: ((Null | RangeP[0*Minute, $MaxExperimentTime]) | Automatic) | Null
    Index Matches to: Sample

    IncubateAliquotContainer

    The desired type of container that should be used to prepare and house the incubation samples which should be used in lieu of the SamplesIn for the experiment.
    Default Value: Automatic
    Pattern Description: An object of type or subtype Model[Container] or {Index, Container} or Null.
    Programmatic Pattern: ((Null | (ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic})) | Automatic) | Null
    Index Matches to: Sample

    IncubateAliquotDestinationWell

    The desired position in the corresponding IncubateAliquotContainer in which the aliquot samples will be placed.
    Default Value: Automatic
    Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
    Pattern Description: Any well from A1 to H12 or Null.
    Programmatic Pattern: ((Null | WellPositionP) | Automatic) | Null
    Index Matches to: Sample

    IncubateAliquot

    The amount of each sample that should be transferred from the SamplesIn into the IncubateAliquotContainer when performing an aliquot before incubation.
    Default Value: Automatic
    Default Calculation: Automatically set as the smaller between the current sample volume and the maximum volume of the destination container.
    Pattern Description: All or greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
    Programmatic Pattern: ((Null | (RangeP[1*Microliter, 20*Liter] | All)) | Automatic) | Null
    Index Matches to: Sample

    Preparatory Centrifugation

    Centrifuge

    Indicates if the SamplesIn should be centrifuged prior to starting the experiment or any aliquoting. Sample Preparation occurs in the order of Incubation, Centrifugation, Filtration, and then Aliquoting (if specified).
    Default Value: Automatic
    Default Calculation: Resolves to True if any of the corresponding Centrifuge options are set. Otherwise, resolves to False.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

    CentrifugeInstrument

    The centrifuge that will be used to spin the provided samples prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: An object of type or subtype Model[Instrument, Centrifuge] or Object[Instrument, Centrifuge] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Instrument, Centrifuge], Object[Instrument, Centrifuge]}]) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeIntensity

    The rotational speed or the force that will be applied to the samples by centrifugation prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Greater than 0 revolutions per minute or greater than 0 standard accelerations due to gravity on the surface of the earth or Null.
    Programmatic Pattern: ((Null | (GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration])) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeTime

    The amount of time for which the SamplesIn should be centrifuged prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Greater than 0 minutes or Null.
    Programmatic Pattern: ((Null | GreaterP[0*Minute]) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeTemperature

    The temperature at which the centrifuge chamber should be held while the samples are being centrifuged prior to starting the experiment.
    Default Value: Automatic
    Pattern Description: Ambient or greater than or equal to -10 degrees Celsius and less than or equal to 40 degrees Celsius or Null.
    Programmatic Pattern: ((Null | (Ambient | RangeP[-10*Celsius, 40*Celsius])) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeAliquotContainer

    The desired type of container that should be used to prepare and house the centrifuge samples which should be used in lieu of the SamplesIn for the experiment.
    Default Value: Automatic
    Pattern Description: An object of type or subtype Model[Container] or {Index, Container} or Null.
    Programmatic Pattern: ((Null | (ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic})) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeAliquotDestinationWell

    The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
    Default Value: Automatic
    Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
    Pattern Description: Any well from A1 to H12 or Null.
    Programmatic Pattern: ((Null | WellPositionP) | Automatic) | Null
    Index Matches to: Sample

    CentrifugeAliquot

    The amount of each sample that should be transferred from the SamplesIn into the CentrifugeAliquotContainer when performing an aliquot before centrifugation.
    Default Value: Automatic
    Default Calculation: Automatically set as the smaller between the current sample volume and the maximum volume of the destination container.
    Pattern Description: All or greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
    Programmatic Pattern: ((Null | (RangeP[1*Microliter, 20*Liter] | All)) | Automatic) | Null
    Index Matches to: Sample

    Preparatory Filtering

    Filtration

    Indicates if the SamplesIn should be filter prior to starting the experiment or any aliquoting. Sample Preparation occurs in the order of Incubation, Centrifugation, Filtration, and then Aliquoting (if specified).
    Default Value: Automatic
    Default Calculation: Resolves to True if any of the corresponding Filter options are set. Otherwise, resolves to False.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

    FiltrationType

    The type of filtration method that should be used to perform the filtration.
    Default Value: Automatic
    Default Calculation: Will automatically resolve to a filtration type appropriate for the volume of sample being filtered.
    Pattern Description: PeristalticPump, Centrifuge, Vacuum, Syringe, or AirPressure or Null.
    Programmatic Pattern: ((Null | FiltrationTypeP) | Automatic) | Null
    Index Matches to: Sample

    FilterInstrument

    The instrument that should be used to perform the filtration.
    Default Value: Automatic
    Default Calculation: Will automatically resolved to an instrument appropriate for the filtration type.
    Pattern Description: An object of type or subtype Model[Instrument, FilterBlock], Object[Instrument, FilterBlock], Model[Instrument, PeristalticPump], Object[Instrument, PeristalticPump], Model[Instrument, VacuumPump], Object[Instrument, VacuumPump], Model[Instrument, Centrifuge], Object[Instrument, Centrifuge], Model[Instrument, SyringePump], or Object[Instrument, SyringePump] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Instrument, FilterBlock], Object[Instrument, FilterBlock], Model[Instrument, PeristalticPump], Object[Instrument, PeristalticPump], Model[Instrument, VacuumPump], Object[Instrument, VacuumPump], Model[Instrument, Centrifuge], Object[Instrument, Centrifuge], Model[Instrument, SyringePump], Object[Instrument, SyringePump]}]) | Automatic) | Null
    Index Matches to: Sample

    Filter

    The filter that should be used to remove impurities from the SamplesIn prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Will automatically resolve to a filter appropriate for the filtration type and instrument.
    Pattern Description: An object of type or subtype Model[Container, Plate, Filter], Model[Container, Vessel, Filter], or Model[Item, Filter] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Container, Plate, Filter], Model[Container, Vessel, Filter], Model[Item, Filter]}]) | Automatic) | Null
    Index Matches to: Sample

    FilterMaterial

    The membrane material of the filter that should be used to remove impurities from the SamplesIn prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Resolves to an appropriate filter material for the given sample is Filtration is set to True.
    Pattern Description: Cellulose, Cotton, Polyethylene, Polypropylene, PTFE, Nylon, PES, PLUS, PVDF, GlassFiber, GHP, UHMWPE, EPDM, DuraporePVDF, GxF, ZebaDesaltingResin, NickelResin, AgaroseResin, CobaltResin, Silica, HLB, or AnoporeAlumina or Null.
    Programmatic Pattern: ((Null | FilterMembraneMaterialP) | Automatic) | Null
    Index Matches to: Sample

    PrefilterMaterial

    The material from which the prefilter filtration membrane should be made of to remove impurities from the SamplesIn prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: By default, no prefiltration is performed on samples, even when Filter->True.
    Pattern Description: Cellulose, Cotton, Polyethylene, Polypropylene, PTFE, Nylon, PES, PLUS, PVDF, GlassFiber, GHP, UHMWPE, EPDM, DuraporePVDF, GxF, ZebaDesaltingResin, NickelResin, AgaroseResin, CobaltResin, Silica, HLB, or AnoporeAlumina or Null.
    Programmatic Pattern: ((Null | FilterMembraneMaterialP) | Automatic) | Null
    Index Matches to: Sample

    FilterPoreSize

    The pore size of the filter that should be used when removing impurities from the SamplesIn prior to starting the experiment.
    Default Value: Automatic
    Default Calculation: Resolves to an appropriate filter pore size for the given sample is Filtration is set to True.
    Pattern Description: 0.008 micrometers, 0.02 micrometers, 0.1 micrometers, 0.2 micrometers, 0.22 micrometers, 0.45 micrometers, 1. micrometer, 1.1 micrometers, 2.5 micrometers, 6. micrometers, 20. micrometers, 30. micrometers, or 100. micrometers or Null.
    Programmatic Pattern: ((Null | FilterSizeP) | Automatic) | Null
    Index Matches to: Sample

    PrefilterPoreSize

    The pore size of the filter; all particles larger than this should be removed during the filtration.
    Default Value: Automatic
    Default Calculation: By default, no prefiltration is performed on samples, even when Filter->True.
    Pattern Description: 0.008 micrometers, 0.02 micrometers, 0.1 micrometers, 0.2 micrometers, 0.22 micrometers, 0.45 micrometers, 1. micrometer, 1.1 micrometers, 2.5 micrometers, 6. micrometers, 20. micrometers, 30. micrometers, or 100. micrometers or Null.
    Programmatic Pattern: ((Null | FilterSizeP) | Automatic) | Null
    Index Matches to: Sample

    FilterSyringe

    The syringe used to force that sample through a filter.
    Default Value: Automatic
    Default Calculation: Resolves to an syringe appropriate to the volume of sample being filtered, if Filtration is set to True.
    Pattern Description: An object of type or subtype Model[Container, Syringe] or Object[Container, Syringe] or a prepared sample or Null.
    Programmatic Pattern: ((Null | (ObjectP[{Model[Container, Syringe], Object[Container, Syringe]}] | _String)) | Automatic) | Null
    Index Matches to: Sample

    FilterHousing

    The filter housing that should be used to hold the filter membrane when filtration is performed using a standalone filter membrane.
    Default Value: Automatic
    Default Calculation: Resolve to an housing capable of holding the size of the membrane being used, if filter with Membrane FilterType is being used and Filtration is set to True.
    Pattern Description: An object of type or subtype Model[Instrument, FilterHousing], Object[Instrument, FilterHousing], Model[Instrument, FilterBlock], or Object[Instrument, FilterBlock] or Null.
    Programmatic Pattern: ((Null | ObjectP[{Model[Instrument, FilterHousing], Object[Instrument, FilterHousing], Model[Instrument, FilterBlock], Object[Instrument, FilterBlock]}]) | Automatic) | Null
    Index Matches to: Sample

    FilterIntensity

    The rotational speed or force at which the samples will be centrifuged during filtration.
    Default Value: Automatic
    Default Calculation: Will automatically resolve to 2000 GravitationalAcceleration if FiltrationType is Centrifuge and Filtration is True.
    Pattern Description: Greater than 0 revolutions per minute or greater than 0 standard accelerations due to gravity on the surface of the earth or Null.
    Programmatic Pattern: ((Null | (GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration])) | Automatic) | Null
    Index Matches to: Sample

    FilterTime

    The amount of time for which the samples will be centrifuged during filtration.
    Default Value: Automatic
    Default Calculation: Will automatically resolve to 5 Minute if FiltrationType is Centrifuge and Filtration is True.
    Pattern Description: Greater than 0 minutes or Null.
    Programmatic Pattern: ((Null | GreaterP[0*Minute]) | Automatic) | Null
    Index Matches to: Sample

    FilterTemperature

    The temperature at which the centrifuge chamber will be held while the samples are being centrifuged during filtration.
    Default Value: Automatic
    Default Calculation: Will automatically resolve to 22 Celsius if FiltrationType is Centrifuge and Filtration is True.
    Pattern Description: Greater than or equal to 4 degrees Celsius or Null.
    Programmatic Pattern: ((Null | (Alternatives[GreaterEqualP[4*Celsius]])) | Automatic) | Null
    Index Matches to: Sample

    FilterContainerOut

    The desired container filtered samples should be produced in or transferred into by the end of filtration, with indices indicating grouping of samples in the same plates, if desired.
    Default Value: Automatic
    Default Calculation: Automatically set as the PreferredContainer for the Volume of the sample. For plates, attempts to fill all wells of a single plate with the same model before using another one.
    Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or {Index, Container} or Null.
    Programmatic Pattern: ((Null | ((ObjectP[{Model[Container], Object[Container]}] | _String) | {GreaterEqualP[1, 1] | Automatic, (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic})) | Automatic) | Null
    Index Matches to: Sample

    FilterAliquotDestinationWell

    The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
    Default Value: Automatic
    Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
    Pattern Description: Any well from A1 to H12 or Null.
    Programmatic Pattern: ((Null | WellPositionP) | Automatic) | Null
    Index Matches to: Sample

    FilterAliquotContainer

    The desired type of container that should be used to prepare and house the filter samples which should be used in lieu of the SamplesIn for the experiment.
    Default Value: Automatic
    Pattern Description: An object of type or subtype Model[Container] or {Index, Container} or Null.
    Programmatic Pattern: ((Null | (ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic})) | Automatic) | Null
    Index Matches to: Sample

    FilterAliquot

    The amount of each sample that should be transferred from the SamplesIn into the FilterAliquotContainer when performing an aliquot before filtration.
    Default Value: Automatic
    Default Calculation: Automatically set as the smaller between the current sample volume and the maximum volume of the destination container.
    Pattern Description: All or greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
    Programmatic Pattern: ((Null | (RangeP[1*Microliter, 20*Liter] | All)) | Automatic) | Null
    Index Matches to: Sample

    FilterSterile

    Indicates if the filtration of the samples should be done in a sterile environment.
    Default Value: Automatic
    Default Calculation: Resolve to False if Filtration is indicated. If sterile filtration is desired, this option must manually be set to True.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Sample

    Aliquoting

    Aliquot

    Indicates if aliquots should be taken from the SamplesIn and transferred into new AliquotSamples used in lieu of the SamplesIn for the experiment. Note that if NumberOfReplicates is specified this indicates that the input samples will also be aliquoted that number of times. Note that Aliquoting (if specified) occurs after any Sample Preparation (if specified).
    Default Value: Automatic
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: Sample

    AliquotSampleLabel

    A user defined word or phrase used to identify the samples after they are aliquotted, for use in downstream unit operations.
    Default Value: Automatic
    Pattern Description: A string or Null.
    Programmatic Pattern: ((Null | _String) | Automatic) | Null
    Index Matches to: Sample

    AliquotAmount

    The amount of a sample that should be transferred from the input samples into aliquots.
    Default Value: Automatic
    Default Calculation: Automatically set as the smaller between the current sample volume and the maximum volume of the destination container if a liquid, or the current Mass or Count if a solid or counted item, respectively.
    Pattern Description: All or Count or Count or Mass or Volume or Null.
    Programmatic Pattern: ((Null | (RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All)) | Automatic) | Null
    Index Matches to: Sample

    TargetConcentration

    The desired final concentration of analyte in the AliquotSamples after dilution of aliquots of SamplesIn with the ConcentratedBuffer and BufferDiluent which should be used in lieu of the SamplesIn for the experiment.
    Default Value: Automatic
    Default Calculation: Automatically calculated based on aliquot and buffer volumes.
    Pattern Description: Greater than 0 molar or greater than 0 grams per liter or Null.
    Programmatic Pattern: ((Null | (GreaterP[0*Molar] | GreaterP[0*(Gram/Liter)])) | Automatic) | Null
    Index Matches to: Sample

    TargetConcentrationAnalyte

    The substance whose final concentration is attained with the TargetConcentration option.
    Default Value: Automatic
    Default Calculation: Automatically set to the first value in the Analytes field of the input sample, or, if not populated, to the first analyte in the Composition field of the input sample, or if none exist, the first identity model of any kind in the Composition field.
    Pattern Description: An object of type or subtype Model[Molecule], Model[Molecule, cDNA], Model[Molecule, Oligomer], Model[Molecule, Transcript], Model[Molecule, Protein], Model[Molecule, Protein, Antibody], Model[Molecule, Carbohydrate], Model[Molecule, Polymer], Model[Resin], Model[Resin, SolidPhaseSupport], Model[Lysate], Model[ProprietaryFormulation], Model[Virus], Model[Cell], Model[Cell, Mammalian], Model[Cell, Bacteria], Model[Cell, Yeast], Model[Tissue], Model[Material], or Model[Species] or Null.
    Programmatic Pattern: ((Null | ObjectP[IdentityModelTypes]) | Automatic) | Null
    Index Matches to: Sample

    AssayVolume

    The desired total volume of the aliquoted sample plus dilution buffer.
    Default Value: Automatic
    Default Calculation: Automatically determined based on Volume and TargetConcentration option values.
    Pattern Description: Greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
    Programmatic Pattern: ((Null | RangeP[1*Microliter, 20*Liter]) | Automatic) | Null
    Index Matches to: Sample

    ConcentratedBuffer

    The concentrated buffer which should be diluted by the BufferDilutionFactor in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent). The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the AliquotAmount and the total AssayVolume.
    Default Value: Automatic
    Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((Null | (ObjectP[{Model[Sample], Object[Sample]}] | _String)) | Automatic) | Null
    Index Matches to: Sample

    BufferDilutionFactor

    The dilution factor by which the concentrated buffer should be diluted in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent). The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the AliquotAmount and the total AssayVolume.
    Default Value: Automatic
    Default Calculation: If ConcentratedBuffer is specified, automatically set to the ConcentratedBufferDilutionFactor of that sample; otherwise, set to Null.
    Pattern Description: Greater than or equal to 1 or Null.
    Programmatic Pattern: ((Null | GreaterEqualP[1]) | Automatic) | Null
    Index Matches to: Sample

    BufferDiluent

    The buffer used to dilute the aliquot sample such that ConcentratedBuffer is diluted by BufferDilutionFactor in the final solution. The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the AliquotAmount and the total AssayVolume.
    Default Value: Automatic
    Default Calculation: Automatically resolves to Model[Sample, "Milli-Q water"] if ConcentratedBuffer is specified; otherwise, resolves to Null.
    Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((Null | (ObjectP[{Model[Sample], Object[Sample]}] | _String)) | Automatic) | Null
    Index Matches to: Sample

    AssayBuffer

    The buffer that should be added to any aliquots requiring dilution, where the volume of this buffer added is the difference between the AliquotAmount and the total AssayVolume.
    Default Value: Automatic
    Default Calculation: Automatically resolves to Model[Sample, "Milli-Q water"] if ConcentratedBuffer is not specified; otherwise, resolves to Null.
    Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((Null | (ObjectP[{Model[Sample], Object[Sample]}] | _String)) | Automatic) | Null
    Index Matches to: Sample

    AliquotSampleStorageCondition

    The non-default conditions under which any aliquot samples generated by this experiment should be stored after the protocol is completed.
    Default Value: Automatic
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
    Programmatic Pattern: ((Null | (SampleStorageTypeP | Disposal)) | Automatic) | Null
    Index Matches to: Sample

    DestinationWell

    The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
    Default Value: Automatic
    Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
    Pattern Description: Any well from A1 to H12 or list of one or more any well from A1 to H12 or any well from A1 to H12 entries or Null.
    Programmatic Pattern: ((WellPositionP | {((Automatic | Null) | WellPositionP)..}) | Automatic) | Null

    AliquotContainer

    The desired type of container that should be used to prepare and house the aliquot samples, with indices indicating grouping of samples in the same plates, if desired. This option will resolve to be the length of the SamplesIn * NumberOfReplicates.
    Default Value: Automatic
    Default Calculation: Automatically set as the PreferredContainer for the AssayVolume of the sample. For plates, attempts to fill all wells of a single plate with the same model before aliquoting into the next.
    Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or Automatic or Null or {Index, Container} or list of one or more an object of type or subtype Model[Container] or Object[Container] or a prepared sample or Automatic or Null entries or list of one or more Automatic or Null or {Index, Container} entries.
    Programmatic Pattern: (((ObjectP[{Model[Container], Object[Container]}] | _String) | (Automatic | Null) | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | (Automatic | Null)} | {((ObjectP[{Model[Container], Object[Container]}] | _String) | (Automatic | Null))..} | {({GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | (Automatic | Null)} | (Automatic | Null))..}) | Automatic) | Null

    AliquotPreparation

    Indicates the desired scale at which liquid handling used to generate aliquots will occur.
    Default Value: Automatic
    Default Calculation: Automatic resolution will occur based on manipulation volumes and container types.
    Pattern Description: Manual or Robotic or Null.
    Programmatic Pattern: (PreparationMethodP | Automatic) | Null

    ConsolidateAliquots

    Indicates if identical aliquots should be prepared in the same container/position.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

Protocol Options

    Post Experiment

    MeasureWeight

    Indicates if any solid samples that are modified in the course of the experiment should have their weights measured and updated after running the experiment. Please note that public samples are weighed regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

    MeasureVolume

    Indicates if any liquid samples that are modified in the course of the experiment should have their volumes measured and updated after running the experiment. Please note that public samples are volume measured regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

    ImageSample

    Indicates if any samples that are modified in the course of the experiment should be freshly imaged after running the experiment. Please note that public samples are imaged regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

Example Calls

    Basic Examples

    Generate Pellet primitives with multiple samples and save all of the supernatant:
    Generate Pellet primitives with multiple samples and discard a specific amount of supernatant:
    Specify to mix the samples after resuspension:
    Specify a high intensity (>15000 RPM) and/or Optima XPN 80 Preparative Ultracentrifuge as the instrument to use the ultracentrifuge to as the instrument:

    Execute the primitive by Experiment, ExperimentSamplePreparation, ExperimentSamplePreparation, ExperimentManualSamplePreparation and ExperimentRoboticSamplePreparation

    User ExperimentRoboticSamplePreparation to enqueue a Pellet experiment by using liquid handler:
    Use ExperimentManualSamplePreparation to enqueue a manual pellet experiment:
    Experiment and ExperimentSamplePreparation will auto determine if the protocol will be executed based on input containers and specified options, see PossibleIssues for more information:

Preferred Input Containers

    Containers that are compatible with the Microfuge 16 model centrifuge.
    Containers that are compatible with the Microfuge 20R model centrifuge.

Warnings and Errors

    Messages

Possible Issues

    Manual Pellet Exclusive Options

    Those options are only available for manual pellet experiment: SupernatantTransferInstrument, ResuspensionMixUntilDissolved, ResuspensionMixMaxTemperature, ResuspensionMixAmplitude, ResuspensionMixMaxTime, ResuspensionMixUntilDissolved, ResuspensionInstrument, ResuspensionMaxNumberOfMixes, ResuspensionMixDutyCycle.

    Limited Option Choices for Robotic Pellet

    For Robotic Pellet primitives, Temperature, Instrument and ResuspensionMixType support fewer options than Manual Pritimives: 1. The Temperature needs to be Ambient; 2. The Instrument needs to be Model[Instrument, Centrifuge, "VSpin"]; 3. The ResuspensionMixType is either Shake or Pipette.

    Can Remove All SupernatantVolume in Manual Pellet Primitive

    For pellet experiment, if All is specified in SupernatantVolume, all solvent will be removed after the centrifugation. However, since "All" can only be judged by a lab operator, robotic pellet primitive does not include All as the choice for SupernatantVolume. Therefore, if removing all solution after the centrifugation is desired, please try using manual pellet primitives.

    Lack of Pellet Formation

    For each member of Sample in manual Pellet Experiment, the operator is asked if a visible pellet is formed at the bottom of the container. The operator's answer will be stored in the DefinedPellet field.
Last modified on Fri 12 Sep 2025 14:58:14

EMERALD CLOUD LAB
15500 Wells Port Drive
Austin, TX 78728
© 2025 Emerald Cloud Lab, Inc.