ExperimentFilter
ExperimentFilter[Objects]⟹Protocol
creates a filter Protocol which can use a variety of different techniques to purify Objects.
ExperimentFilter may be used for the separation of particles from a liquid by passing the liquid through a membrane. The membrane's pore size will determine what sized particles will be separated from the solution. Other membrane considerations include the chemical compatibility between membrane material and the liquid, as well as the binding of solution components (e.g. proteins) to the membrane. Additionally, the liquid can be passed through the membrane using a variety of methods, such as syringes, peristaltic pumps, vacuum pumps, and centrifuges.
Experimental Principles
Figure 1.1: Procedural overview of a filtration experiment (syringe filter). Step 1: The sample is transferred into a syringe Step 2: The syringe is used to pass the sample through a filter attached to the tip of the syringe. Step 3: The sample is collected in a new vessel.
Figure 1.2: Procedural overview of a filtration experiment (bottle-top filter). Step 1: The sample is transferred into a bottle-top filtration unit. Step 2: A vacuum pump is used to pass the sample through a filter embedded in the filtration unit. Step 3 (Optional): More buffer is added and passed through the filter to wash the retentate. Step 4: The sample is collected in a new vessel. Optionally, the retentate is collected as well, via solid transfer or resuspension and transfer into a new container.
Figure 1.3: Procedural overview of a filtration experiment (filter housing). Step 1: Tubing is placed inside the sample's container. Step 2: A peristaltic pump is used to pass the sample through a filter installed in a filter housing. Step 3: The sample is collected in a new vessel.
Figure 1.4: Procedural overview of a filtration experiment (filter block). Step 1: The sample is transferred into a filter plate. Step 2: A vacuum pump is used to pass the sample through the filters embedded in the filter plate. Step 3 (Optional): More buffer is added and passed through the filter to wash the retentate. Step 4: The sample is collected in a new plate. Optionally, the retentate is collected as well, via solid transfer or resuspension and transfer into a new container.
Figure 1.5: Procedural overview of a filtration experiment (centrifuge filter). Step 1: The sample is transferred into the filter compartment of a filter tube. Step 2: A centrifuge is used to pass the sample through the filter inserted in the filter tube. Step 3 (Optional): More buffer is added and passed through the filter to wash the retentate. Step 4: The sample is collected in the bottom of the filter tube. Optionally, the retentate is collected as well, via solid transfer, resuspension and transfer into a new container, or by inverting the filter in a new tube and centrifuging it.
Instrumentation
Filter Membrane Housing, 142 mm
Figure 2.1: Instrument diagram for the Filter Membrane Housing, 142 mm: The housing is made up of a top plate that is attached to the inlet port, and a bottom plate that is attached to the outlet port. A semi-permeable filter membrane is immobilized between the top and bottom plates as they are brought together. Liquid is then pumped from the inlet port through the filter membrane and into the outlet port, where it is diverted via tubing into a collection vessel.
Filter Block
Figure 2.2: Instrument diagram for the Filter Block: A filter plate containing sample is positioned inside of a collar which fits over a collection plate within the vacuum manifold. A vacuum generates a pressure gradient that causes the sample to flow through the filter into the collection vessel.
NE-1010 Syringe Pump
Figure 2.3: Samples to be filtered are taken up into a syringe, and a filter is then inserted onto the end of the syringe. The syringe-filter complex is placed onto the syringe pump, and tubing is added connecting the filter to the collection container. The syringe pump then presses agains the syringe's plunger at the specified FlowRate until all liquid has been pushed through the filter.
Avanti J-15R
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.
Avanti J-15R with JA-10.100 Fixed Angle Rotor
Figure 2.5: 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.6: 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.
Sterile Microfuge 16
Figure 2.7: 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.8: 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.9: 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.
VSpin
Figure 2.10: The VSpin robotic centrifuge has a swinging bucket rotor that can hold two SBS standard plates. Plates can be loaded and spins can be performed fully robotically. This centrifuge is accessible only using RoboticSamplePreparation protocols.
MPE2
Figure 2.11: Samples to be filtered are transferred into a filter plate stacked on the top of a collection container plate. The stacked plates are then moved into the pressure manifold and lifted up to the air inlet by elevators. All liquids are then pushed through the filter plate into the collection container plate by applying possitive air pressure from top.
Experiment Options
General
CollectionContainer
The container that will be used to accumulate the filtrate when filtering by Centrifuge or Vacuum and Buchner funnel (if applicable).
Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic) | Null
Volume
The amount of sample to be transferred into the filter (if it is not already there) prior to its filtration. This option can only be set if Preparation->Robotic.
WashFlowThroughContainer
The container holding sample that is run through the retentate and filter after initial filtration prior to retentate collection. This value can contain one or multiple different containers of flow through samples per input sample.
Default Calculation: Automatically set to the same value as FiltrateContainerOut if WashRetentate -> True, or Null otherwise.
Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or list of one or more an object of type or subtype Model[Container] or Object[Container] or a prepared sample or Null or Automatic entries or Null.
Programmatic Pattern: (((ObjectP[{Model[Container], Object[Container]}] | _String) | {((ObjectP[{Model[Container], Object[Container]}] | _String) | (Null | Automatic))..}) | Automatic) | Null
WashFlowThroughDestinationWell
The position in the container holding sample that is run through the retentate and filter after initial filtration prior to retentate collection.
Default Calculation: Automatically set to the same value as FiltrateContainerOut if WashRetentate -> True, or Null otherwise.
Pattern Description: Any well from A1 to H12 or list of one or more any well from A1 to H12 or Null or Automatic entries or Null.
Programmatic Pattern: ((WellPositionP | {(WellPositionP | (Null | Automatic))..}) | Automatic) | Null
WorkCell
The automated workstation with a collection of integrated instruments on which this unit operation will be will be performed if Preparation -> Robotic.
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.
Method
FiltrationType
The type of dead-end filtration method that should be used to perform the filtration. This option can only be set to AirPressure if Preparation->Robotic.
Default Calculation: Will be automatically set to a filtration type appropriate for the volume of sample being filtered.
Time
Default Calculation: For Syringe filtration, automatically set to the MaxVolume of the syringe divided by the desired flow rate. This option may be overwritten if both FlowRate and Time options are provided. For other filtration types, automatically set to 5 minutes, or the value of MaxTime, whichever is shorter.
FilterUntilDrained
Indicates if the filtration should be continued until the sample has all been filtered, or up to the MaxTime, in an attempt to filter the entire sample.
Default Calculation: Automatically set to True if MaxTime is specified, or if Type is set to PeristalticPump or Vacuum. Automatically set to False otherwise.
MaxTime
Maximum duration of time for which the samples will be filtered, if the FilterUntilDrained option is chosen. Note this option only applies for filtration types: PeristalticPump or Vacuum.
Default Calculation: Automatically set to 3 * Time if Type is PeristalticPump or Vacuum, or Null otherwise.
Instrument
The instrument that should be used to perform the filtration. This option can only be set to pressure filter if Preparation->Robotic.
Default Calculation: Will be automatically set to an instrument appropriate for the filtration type.
Pattern Description: An object of type or subtype Model[Instrument, PeristalticPump], Object[Instrument, PeristalticPump], Model[Instrument, VacuumPump], Object[Instrument, VacuumPump], Model[Instrument, Centrifuge], Object[Instrument, Centrifuge], Model[Instrument, SyringePump], Object[Instrument, SyringePump], Model[Instrument, PressureManifold], or Object[Instrument, PressureManifold]
Programmatic Pattern: ObjectP[{Model[Instrument, PeristalticPump], Object[Instrument, PeristalticPump], Model[Instrument, VacuumPump], Object[Instrument, VacuumPump], Model[Instrument, Centrifuge], Object[Instrument, Centrifuge], Model[Instrument, SyringePump], Object[Instrument, SyringePump], Model[Instrument, PressureManifold], Object[Instrument, PressureManifold]}] | Automatic
Syringe
Default Calculation: Automatically set to an syringe appropriate to the volume of sample being filtered.
Pattern Description: An object of type or subtype Model[Container, Syringe] or Object[Container, Syringe] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Container, Syringe], Object[Container, Syringe]}] | _String) | Automatic) | Null
FlowRate
Pattern Description: Greater than or equal to 0.1 milliliters per minute and less than or equal to 20 milliliters per minute or Null.
Sterile
Default Calculation: Automatically set to True if WorkCell is set to bioSTAR, or if Instrument is set to Model[Instrument, Centrifuge, "HiG4"].
FilterHousing
The filter housing that should be used to hold the filter membrane when filtration is performed using a standalone filter membrane on peristaltic pump.
Default Calculation: Automatically set to a housing capable of holding the size of the membrane being used, if filter with Membrane FilterType is being used.
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: (ObjectP[{Model[Instrument, FilterHousing], Object[Instrument, FilterHousing], Model[Instrument, FilterBlock], Object[Instrument, FilterBlock]}] | Automatic) | Null
Temperature
The temperature at which the centrifuge chamber will be held while the samples are being centrifuged during filtration.
Default Calculation: Will be automatically set to $AmbientTemperature if filtering type is Centrifuge.
Pressure
Counterweight
Default Calculation: Automatically set to the appropriate model for the weight of the samples if FiltrationType -> Centrifuge, or Null otherwise.
Pattern Description: An object of type or subtype Model[Item, Counterweight] or Object[Item, Counterweight] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Item, Counterweight], Object[Item, Counterweight]}] | _String) | Automatic) | Null
Protocol
Intensity
Default Calculation: Will be automatically set to 2000 GravitationalAcceleration if filtering type is Centrifuge.
Programmatic Pattern: ((GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration]) | Automatic) | Null
Target
Indicates if the filtrate samples or retentate samples should populate SamplesOut. Note that if set to Retentate, Filtrate will still be collected as well, just not populated in SamplesOut.
PrewetFilterCentrifugeIntensity
The rotational speed or force at which the PrewetFilterBuffer will be centrifuged prior to filtration.
Default Calculation: Will be automatically set to the value of Intensity of centrifuging, or Null otherwise.
Programmatic Pattern: ((GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration]) | Automatic) | Null
FiltrateContainerOut
The desired container generated samples should be produced in or transferred into by the end of the experiment, with indices indicating grouping of samples in the same plates.
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}
Programmatic Pattern: ((ObjectP[{Model[Container], Object[Container]}] | _String) | {GreaterEqualP[1, 1] | Automatic, (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic
FiltrateDestinationWell
The desired position in the corresponding FiltrateContainerOut in which the filtrate samples will be placed.
Default Calculation: Automatically set to A1 in containers with only one position. For plates, automatically set to the corresponding value of the FilterPosition option if the CollectionContainer and FiltrateContainerOut are the same. Otherwise, fills wells in the order provided by the function AllWells.
Filter Properties
Filter
Default Calculation: Will be automatically set to a filter appropriate for the filtration type and instrument. If the sample is already in a filter, it will not be moved to a new one unless explicitly specified.
Pattern Description: An object of type or subtype Model[Container, Plate, Filter], Object[Container, Plate, Filter], Model[Container, Vessel, Filter], Object[Container, Vessel, Filter], Model[Item, Filter], Object[Item, Filter], Model[Item, ExtractionCartridge], or Object[Item, ExtractionCartridge] or a prepared sample.
Programmatic Pattern: (ObjectP[{Model[Container, Plate, Filter], Object[Container, Plate, Filter], Model[Container, Vessel, Filter], Object[Container, Vessel, Filter], Model[Item, Filter], Object[Item, Filter], Model[Item, ExtractionCartridge], Object[Item, ExtractionCartridge]}] | _String) | Automatic
FilterPosition
Default Calculation: If the input sample is already in a filter, automatically set to the current position. Otherwise, selects the first empty position in the Filter according to the order indicated in Flatten[AllWells[]] if using container filters, or Null otherwise.
MembraneMaterial
Default Calculation: Will be automatically set to PES or to the MembraneMaterial of Filter if it is specified.
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.
PrefilterMembraneMaterial
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.
PoreSize
The pore size of the filter; all particles larger than this should be removed during the filtration.
Default Calculation: Will be automatically set to .22 Micron or to the PoreSize of Filter if it is specified. Will be automatically set to Null if MolecularWeightCutoff is specified.
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.
MolecularWeightCutoff
The molecular weight cutoff of the filter; all particles larger than this should be removed during the filtration.
Default Calculation: Will be automatically set to Null or to the MolecularWeightCutoff of Filter if it is specified.
Pattern Description: 3 kilograms per mole, 3. kilograms per mole, 10 kilograms per mole, 10. kilograms per mole, 30 kilograms per mole, 30. kilograms per mole, 40 kilograms per mole, 40. kilograms per mole, 50 kilograms per mole, 50. kilograms per mole, 100 kilograms per mole, 100. kilograms per mole, 300 kilograms per mole, 300. kilograms per mole, 7 kilograms per mole, 7. kilograms per mole, 40 kilograms per mole, 40. kilograms per mole, or 30.8328 kilograms per mole or Null.
PrefilterPoreSize
The pore size of the prefilter; all particles larger than this should be removed during the filtration.
Default Calculation: Will be automatically set to .45 Micron if a prefilter membrane material is specified.
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.
FilterStorageCondition
The conditions under which any filters used by this experiment should be stored after the protocol is completed.
WashFlowThroughStorageCondition
The conditions under which any retentate wash flow through generated by this experiment should be stored after the protocol is completed.
Default Calculation: Automatically set to the same value as SamplesOutStorageCondition if WashRetentate -> True, or Null otherwise.
Programmatic Pattern: ((((SampleStorageTypeP | Disposal) | {((SampleStorageTypeP | Disposal) | (Null | Automatic))..}) | (ObjectP[Model[StorageCondition]] | {(ObjectP[Model[StorageCondition]] | (Null | Automatic))..})) | Automatic) | Null
Retentate Collection
CollectRetentate
Indicates if the retentate captured by the filter should be retrieved by direct transfer or resuspension in a new buffer. Note that the Filtrate will always be collected as well, and whether the Filtrate or Retentate are the SamplesOut is dictated by the Target option.
Default Calculation: Automatically set to True if RetentateContainerOut, RetentateDestinationWell, ResuspensionVolume, ResuspensionBuffer, RetentateCollectionMethod, ResuspensionCentrifugeIntensity, or ResuspensionCentrifugeTime are specified, or False otherwise.
RetentateCollectionMethod
Default Calculation: Automatically set to Centrifuge if CollectRetentate -> True and using centrifuge filters that can be inverted inside a new tube and centrifuged again in order to collect retentate. In all other cases, if CollectRetentate is True then set to Resuspend, or Null otherwise.
RetentateContainerOut
The desired container retentate samples should be transferred into after filtering, with indices indicating grouping of samples in the same plates.
Default Calculation: Automatically set as the PreferredContainer for the ResuspensionVolume of the sample. For plates, attempts to fill all wells of a single plate with the same model before using another one. If not collecting the retentate, automatically set to Null.
Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or {Index, Container} or Null.
Programmatic Pattern: (((ObjectP[{Model[Container], Object[Container]}] | _String) | {GreaterEqualP[1, 1] | Automatic, (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic) | Null
RetentateDestinationWell
The desired position in the corresponding RetentateContainerOut in which the retentate samples will be placed.
Default Calculation: Automatically set to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells. If not collecting the retentate, automatically set to Null.
CollectOccludingRetentate
Indicates that if the filter becomes occluded or clogged during the course of filtration, all retentate that cannot be passed through the filter should be collected into the OccludingRetentateContainer. Note that this is currently only done during syringe filtering; for all other filtration types, use the CollectRetentate boolean directly.
Default Calculation: Automatically set to True if FiltrationType is set to Syringe or if OccludingRetentateContainer or OccludingRetentateContainerLabel are specified, and False otherwise.
OccludingRetentateContainer
Indicates the container into which the retentate should be transferred if the filter becomes clogged.
Default Calculation: Automatically set to Null if CollectOccludingRetentate is False, and set to the PreferredContainer of the input sample volume if CollectOccludingRetentate is True
Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic) | Null
OccludingRetentateDestinationWell
The desired position in the corresponding OccludingRetentateContainer in which the occluding retentate samples will be placed.
Default Calculation: Automatically set to Null if CollectOccludingRetentate is False. Automatically set to A1 in containers with only one positionFor plates, fills wells in the order provided by the function AllWells. If not collecting the retentate, automatically set to Null.
ResuspensionVolume
The volume of ResuspensionBuffer to be added to the retentate. This amount will subsequently be resuspended and transferred to RetentateDestinationWell of RetentateContainerOut.
Default Calculation: Automatically set to smaller of the MaxVolume of the RetentateContainerOut and the initial volume of the sample. If not collecting the retentate, automatically set to Null.
Pattern Description: Greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
ResuspensionBuffer
The desired sample in which the retentate is resuspended prior to being transferred to RetentateDestinationWell of RetentateContainerOut.
Default Calculation: Automatically set to Model[Sample, "Milli-Q water"] if collecting retentate, or Null if not.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
NumberOfResuspensionMixes
Default Calculation: Automatically set to 10 if RetentateCollectionMethod -> Transfer, or Null otherwise.
Pattern Description: Greater than or equal to 1 and less than or equal to 50 in increments of 1 or Null.
Retentate Washing
WashRetentate
Indicates if the retentate captured by the filter should be washed with a buffer prior to collection.
Default Calculation: Automatically set to True if RetentateWashBuffer, RetentateWashVolume, NumberOfRetentateWashes, RetentateWashTime, or RetentateWashCentrifugeIntensity is specified, or False otherwise.
RetentateWashBuffer
The sample that is run through the retentate and filter after initial filtration prior to retentate collection. This value can contain one or multiple different buffers per input sample.
Default Calculation: Automatically set to Model[Sample, "Milli-Q water"] if collecting retentate, or Null if not.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or list of one or more an object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null or Automatic entries or Null.
Programmatic Pattern: (((ObjectP[{Model[Sample], Object[Sample]}] | _String) | {((ObjectP[{Model[Sample], Object[Sample]}] | _String) | (Null | Automatic))..}) | Automatic) | Null
RetentateWashVolume
The amount of RetentateWashBuffer that is run through the retentate and filter after initial filtration prior to retentate collection.
Default Calculation: Automatically set to the initial volume of the input sample if WashRetentate -> True, or Null otherwise.
Pattern Description: Greater than or equal to 1 microliter and less than or equal to 20 liters or list of one or more greater than or equal to 1 microliter and less than or equal to 20 liters or Null or Automatic entries or Null.
Programmatic Pattern: ((RangeP[1*Microliter, 20*Liter] | {(RangeP[1*Microliter, 20*Liter] | (Null | Automatic))..}) | Automatic) | Null
NumberOfRetentateWashes
The number of times to run RetentateWashBuffer through the retentate and filter after initial filtration prior to retentate collection. Note that if this number is greater than 1, all those washes will go into the same WashFlowThroughContainer.
Pattern Description: Greater than or equal to 1 in increments of 1 or list of one or more greater than or equal to 1 in increments of 1 entries or list of one or more Null or Automatic entries or Null.
Programmatic Pattern: ((GreaterEqualP[1, 1] | {GreaterEqualP[1, 1]..} | {(Null | Automatic)..}) | Automatic) | Null
RetentateWashDrainTime
The amount of time for which the samples will be washed with RetentateWashBuffer after initial filtration and prior to retentate collection.
Default Calculation: Automatically set to the value of the Time option if WashRetentate -> True, or Null otherwise.
Pattern Description: Greater than 0 minutes or list of one or more greater than 0 minutes or Null or Automatic entries or Null.
Programmatic Pattern: ((GreaterP[0*Minute] | {(GreaterP[0*Minute] | (Null | Automatic))..}) | Automatic) | Null
RetentateWashCentrifugeIntensity
The rotational speed or force at which the retentate that has been washed with RetentateWashBuffer after initial filtration and prior to retentate collection.
Default Calculation: Will be automatically set to CentrifugeIntensity if Method -> Centrifuge and WashRetentate -> True, or Null otherwise.
Programmatic Pattern: (((GreaterP[0*RPM] | {(GreaterP[0*RPM] | (Null | Automatic))..}) | (GreaterP[0*GravitationalAcceleration] | {(GreaterP[0*GravitationalAcceleration] | (Null | Automatic))..})) | Automatic) | Null
RetentateWashMix
Indicates if after RetentateWashBuffer is added to the retentate, the retentate should be mixed prior to filtering wash buffer out.
Pattern Description: List of one or more Null or Automatic or True or False entries or True or False or Null.
NumberOfRetentateWashMixes
Number of times the retentate should be pipetted if WashRetentate -> True and RetentateWashMix -> True.
Default Calculation: Automatically set to 10 if WashRetentate -> True and RetentateWashMix -> True, or Null otherwise.
Pattern Description: Greater than or equal to 1 in increments of 1 or list of one or more greater than or equal to 1 in increments of 1 or Null or Automatic entries or Null.
Programmatic Pattern: ((GreaterEqualP[1, 1] | {(GreaterEqualP[1, 1] | (Null | Automatic))..}) | Automatic) | Null
RetentateWashPressure
The target pressure applied to the retentate that has been washed with RetentateWashBuffer after initial filtration and prior to retentate collection. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to the value of the Pressure option if Method -> AirPressure and WashRetentate -> True, or Null otherwise.
Pattern Description: Greater than 0 pounds‐force per inch squared or list of one or more greater than 0 pounds‐force per inch squared or Null or Automatic entries or Null.
Programmatic Pattern: ((GreaterP[0*PSI] | {(GreaterP[0*PSI] | (Null | Automatic))..}) | Automatic) | Null
Prewetting
PrewetFilter
Indicates if the filter should be pre-wet with PrewetFilterBuffer before the input sample is run through it.
Default Calculation: Automatically set to True if any of the other prewetting options are specified or if the filter has StorageBuffer -> True, or False otherwise.
NumberOfFilterPrewettings
Number of times the filter should be pre-wet with PrewetFilterBuffer before the input sample is run through it. Note that if there is liquid already in the filter, the first iteration will NOT add any buffer.
Default Calculation: Automatically set to 3 if PrewetFilter -> True and the Filter has StorageBuffer -> True, or 1 if PrewetFilter -> True otherwise, or Null if PrewetFilter -> False.
Pattern Description: Greater than or equal to 1 and less than or equal to 5 in increments of 1 or Null.
PrewetFilterTime
Default Calculation: Automatically set to 5 Minute if FiltrationType is set to Centrifuge, or Null otherwise.
PrewetFilterBufferVolume
Indicates the amount of PrewetFilterBuffer to run through the filter prior to running the sample through.
Default Calculation: If the filter has StorageBuffer -> True, automatically set to the filter's StorageBufferVolume. If PrewetFilter -> True otherwise, automatically set to the lesser of 5% of the input sample's volume and the MaxVolume of the filter. Otherwise set to Null.
Pattern Description: Greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
PrewetFilterBuffer
Indicates the sample to run through the filter prior to running the input sample through the filter. Note that this is only supported if Preparation -> Manual.
Default Calculation: Automatically set to the Solvent field of the input sample, or the model of the input sample if it exists and UsedAsSolvent is set to True, or Milli-Q water if it is not, or Null if PrewetFilter is False.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
PrewetFilterContainerOut
Default Calculation: Automatically set to Null if PrewetFilter is set to False. Otherwise, automatically set to the same container model as the CollectionContainer if it is specified, or the same model as the FiltrateContainerOut otherwise.
Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic) | Null
Instrument Specifications
Tips
Default Calculation: Automatically set to a tip that does not conflict with the incompatible materials of the sample(s) that the tip will come in contact with, the amount being transferred, and the source and destination containers of the transfer (accessibility). For more information, please refer to the function TransferDevices[].
Pattern Description: An object of type or subtype Model[Item, Tips], Object[Item, Tips], Model[Item, Consumable], or Object[Item, Consumable] or Null.
Programmatic Pattern: ((Null | ObjectP[{Model[Item, Tips], Object[Item, Tips], Model[Item, Consumable], Object[Item, Consumable]}]) | Automatic) | Null
TipType
Default Calculation: Automatically set to the TipType field of the calculated Tips that will be used to perform the transfer.
TipMaterial
The material of the pipette tips used to aspirate and dispense the requested volume during the transfer.
Default Calculation: Automatically set to the chemistry of the calculated Tips that will be used to perform the transfer.
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.
AspirationRate
The speed at which liquid will be drawn up into the pipette tip. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to DispenseRate if it is specified, otherwise set to 100 Microliter/Second if Preparation->Robotic.
Pattern Description: Greater than or equal to 0.4 microliters per second and less than or equal to 500 microliters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.4*(Microliter/Second), 500*(Microliter/Second)]) | Automatic) | Null
DispenseRate
The speed at which liquid will be expelled from the pipette tip. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to AspirationRate if it is specified, otherwise set to 100 Microliter/Second.
Pattern Description: Greater than or equal to 0.4 microliters per second and less than or equal to 500 microliters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.4*(Microliter/Second), 500*(Microliter/Second)]) | Automatic) | Null
OverAspirationVolume
The volume of air drawn into the pipette tip at the end of the aspiration of a liquid. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to OverDispenseVolume if it is specified, otherwise set to 5 Microliter.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 50 microliters or Null.
OverDispenseVolume
The volume of air blown out at the end of the dispensing of a liquid. This option can only be set if Preparation->Robotic.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 300 microliters or Null.
AspirationWithdrawalRate
The speed at which the pipette is removed from the liquid after an aspiration. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to DispenseWithdrawalRate if it is specified, otherwise set to 2 Millimeter/Second.
Pattern Description: Greater than or equal to 0.3 millimeters per second and less than or equal to 160 millimeters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.3*(Millimeter/Second), 160*(Millimeter/Second)]) | Automatic) | Null
DispenseWithdrawalRate
The speed at which the pipette is removed from the liquid after a dispense. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to AspirationWithdrawalRate if it is specified, otherwise set to 2 Millimeter/Second.
Pattern Description: Greater than or equal to 0.3 millimeters per second and less than or equal to 160 millimeters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.3*(Millimeter/Second), 160*(Millimeter/Second)]) | Automatic) | Null
AspirationEquilibrationTime
The delay length the pipette waits after aspirating before it is removed from the liquid. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to DispenseEquilibrationTime if it is specified, otherwise set to 1 Second.
Pattern Description: Greater than or equal to 0 seconds and less than or equal to 9.9 seconds or Null.
DispenseEquilibrationTime
The delay length the pipette waits after dispensing before it is removed from the liquid. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to AspirationEquilibrationTime if it is specified, otherwise set to 1 Second.
Pattern Description: Greater than or equal to 0 seconds and less than or equal to 9.9 seconds or Null.
AspirationMixRate
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 Calculation: Automatically set to DispenseMixRate or AspirationRate if either is specified, otherwise set to 100 Microliter/Second.
Pattern Description: Greater than or equal to 0.4 microliters per second and less than or equal to 500 microliters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.4*(Microliter/Second), 500*(Microliter/Second)]) | Automatic) | Null
DispenseMixRate
The speed at which liquid is aspirated and dispensed in a liquid after a dispense. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to AspirationMixRate or DispenseRate if either is specified, otherwise set to 100 Microliter/Second.
Pattern Description: Greater than or equal to 0.4 microliters per second and less than or equal to 500 microliters per second or Null.
Programmatic Pattern: ((Null | RangeP[0.4*(Microliter/Second), 500*(Microliter/Second)]) | Automatic) | Null
AspirationPosition
The location from which liquid should be aspirated. Top will aspirate AspirationPositionOffset below the Top of the container, Bottom will aspirate AspirationPositionOffset above the Bottom of the container, LiquidLevel will aspirate AspirationPositionOffset below the liquid level of the sample in the container, and TouchOff will touch the bottom of the container before moving the specified AspirationPositionOffset above the bottom of the container to start aspirate the sample.
Default Calculation: Automatically set to the AspirationPosition in the PipettingMethod if it is specified and Preparation->Robotic, otherwise resolves to TouchOff if Preparation->Robotic.
DispensePosition
The location from which liquid should be dispensed. Top will dispense DispensePositionOffset below the Top of the container, Bottom will dispense DispensePositionOffset above the Bottom of the container, LiquidLevel will dispense DispensePositionOffset below the liquid level of the sample in the container, and TouchOff will touch the bottom of the container before moving the specified DispensePositionOffset above the bottom of the container to start dispensing the sample.
Default Calculation: Automatically set to the DispensePosition in the PipettingMethod if it is specified and Preparation->Robotic, resolved to Bottom for MxN MultiProbeHead transfers, otherwise resolves to TouchOff if Preparation->Robotic.
AspirationPositionOffset
The distance from the center of the well that liquid will aspirated. The Z Offset is based on the AspirationPosition option -- measured as the height below the top of the well (Top), the height above the bottom of the well (Bottom), or the height below the detected liquid level (LiquidLevel), see the AspirationPosition diagram in the help file for more information. If an X and Y offset is not specified, the liquid will be aspirated in the center of the well, otherwise, -X/+X values will shift the position left and right, respectively, and -Y/+Y values will shift the position down and up, respectively. When the source container is tilted (via AspirationAngle), the AspirationPositionOffset automatically accounts for the angle of tilt.
Default Calculation: Automatically set to the AspirationPositionOffset field in the pipetting method, if specified. If AspirationAngle is set, automatically set to the left most point in the well since liquid will pool in the direction that the plate is tilted. Otherwise, is set to 2 Millimeter.
Programmatic Pattern: ((Null | (GreaterEqualP[0*Millimeter] | Coordinate[{DistanceP, DistanceP, GreaterEqualP[0*Millimeter]}])) | Automatic) | Null
AspirationAngle
The angle that the source container will be tilted during the aspiration of liquid. The container is pivoted on its left edge when tilting occurs. This option can only be provided if Preparation->Robotic.
Default Calculation: Automatically set to 0 AngularDegree if Preparation->Robotic. Otherwise, set to Null.
Pattern Description: Greater than or equal to 0 degrees and less than or equal to 10 degrees in increments of 1 degree or Null.
Programmatic Pattern: ((Null | RangeP[0*AngularDegree, 10*AngularDegree, 1*AngularDegree]) | Automatic) | Null
DispensePositionOffset
The distance from the center of the well that liquid will dispensed. The Z Offset is based on the DispensePosition option -- measured as the height below the top of the well (Top), the height above the bottom of the well (Bottom), or the height below the detected liquid level (LiquidLevel), see the DispensePosition diagram in the help file for more information. If an X and Y offset is not specified, the liquid will be dispensed in the center of the well, otherwise, -X/+X values will shift the position left and right, respectively, and -Y/+Y values will shift the position down and up, respectively. When the destination container is tilted (via DispenseAngle), the DispensePositionOffset automatically accounts for the angle of tilt.
Default Calculation: Automatically set to the DispensePositionOffset field in the pipetting method, if specified. If DispenseAngle is set, automatically set to the left most point in the well since liquid will pool in the direction that the plate is tilted. Otherwise, is set to 2 Millimeter.
Programmatic Pattern: ((Null | (GreaterEqualP[0*Millimeter] | Coordinate[{DistanceP, DistanceP, GreaterEqualP[0*Millimeter]}])) | Automatic) | Null
DispenseAngle
The angle that the destination container will be tilted during the dispensing of liquid. The container is pivoted on its left edge when tilting occurs. This option can only be provided if Preparation->Robotic.
Default Calculation: Automatically set to 0 AngularDegree if Preparation->Robotic. Otherwise, set to Null.
Pattern Description: Greater than or equal to 0 degrees and less than or equal to 10 degrees in increments of 1 degree or Null.
Programmatic Pattern: ((Null | RangeP[0*AngularDegree, 10*AngularDegree, 1*AngularDegree]) | Automatic) | Null
CorrectionCurve
The relationship between a target volume and the corrected volume that needs to be aspirated or dispensed to reach the target volume. The correction curve is derived empirically from the relationship between the target and actual amount of volume transferred when on a specific robotic liquid handler instrument model. It is recommended when building one of these curves to measure the volume of sample transferred gravimetrically to get a more accurate CorrectionCurve. Use the function UploadPipettingMethod to create a new pipetting method for a sample model to have all robotic transfers of this sample model to use the derived CorrectionCurve automatically. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to PipettingMethod if it is specified. Otherwise, is set to Null (no correction curve).
Programmatic Pattern: ((Null | {{RangeP[0*Microliter, 1000*Microliter], RangeP[0*Microliter, 1250*Microliter]}..}) | Automatic) | Null
PipettingMethod
The pipetting parameters used to manipulate the source sample. This option can only be set if Preparation->Robotic. If other pipetting options are specified, the parameters from the method here are overwritten.
Default Calculation: Automatically set to the PipettingMethod of the model of the sample if available.
DynamicAspiration
Indicates if droplet formation will be prevented during liquid transfer. This will only be used for solvents that have high vapor pressure. This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to the DynamicAspiration field in the pipetting method, if available.
DeviceChannel
The channel of the work cell that will be used to perform the transfer (MultiProbeHead | SingleProbe1 | SingleProbe2 | SingleProbe3 | SingleProbe4 | SingleProbe5 | SingleProbe6 | SingleProbe7 | SingleProbe8). This option can only be set if Preparation->Robotic.
Default Calculation: Automatically set to SingleProbe1 if MultichannelTransfer->False. Otherwise, set to the appropriate channel to perform the transfer.
Pattern Description: MultiProbeHead, SingleProbe1, SingleProbe2, SingleProbe3, SingleProbe4, SingleProbe5, SingleProbe6, SingleProbe7, or SingleProbe8 or Null.
Transfer Technique
ReversePipetting
Indicates if additional source sample will be aspirated (past the first stop of the pipette) to reduce the chance of bubble formation when dispensing into the destination position. This option can only be set if Preparation->Manual.
Default Calculation: Automatically set to True if the source or destination sample has the ReversePipetting field set and the transfer is occurring via pipette.
SlurryTransfer
Indicates if the source sample should be mixed via pipette until it becomes homogeneous, up to MaxNumberOfAspirationMixes times.
Default Calculation: Automatically set to True if the SampleHandling of the source sample is set to Slurry.
AspirationMix
Indicates if the source sample will be mixed immediately before it is transferred into the destination sample.
Default Calculation: Automatically set to True if any of the other AspirationMix options are set. Otherwise, set to Null.
DispenseMix
Indicates if the destination sample will be mixed immediately after the source sample is transferred into the destination sample.
Default Calculation: Automatically set to True if any of the other DispenseMix options are set. Otherwise, set to Null.
AspirationMixVolume
The volume that will be repeatedly aspirated and dispensed via pipette from the source sample in order to mix the source sample immediately before the transfer occurs. The same pipette and tips used in the transfer will be used to mix the source sample.
Default Calculation: Automatically set to 1/2 the volume of the source sample or the maximum volume of the pipette being used, depending on which value is smaller.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 50 milliliters or Null.
NumberOfAspirationMixes
The number of times the source is quickly aspirated and dispensed to mix the source sample immediately before it is transferred into the destination.
Default Calculation: Automatically set to 5 if any of the other AspirationMix options are set. Otherwise, set to Null.
Pattern Description: Greater than or equal to 0 and less than or equal to 50 in increments of 1 or Null.
MaxNumberOfAspirationMixes
The number of times the source is quickly aspirated and dispensed to mix the source sample immediately before it is transferred into the destination.
Default Calculation: Automatically set to 5 if any of the other AspirationMix options are set. Otherwise, set to Null.
Pattern Description: Greater than or equal to 0 and less than or equal to 100 in increments of 1 or Null.
DispenseMixVolume
The volume that will be repeatedly aspirated and dispensed via pipette from the destination sample in order to mix the destination sample immediately after the transfer occurs. The same pipette and tips used in the transfer will be used to mix the destination sample.
Default Calculation: Automatically set to 1/2 the volume of the destination sample or the maximum volume of the pipette being used, depending on which value is smaller.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 50 milliliters or Null.
NumberOfDispenseMixes
The number of times the destination is quickly aspirated and dispensed to mix the destination sample immediately after the source is dispensed.
Default Calculation: Automatically set to 5 if any of the other DispenseMix options are set. Otherwise, set to Null.
Pattern Description: Greater than or equal to 0 and less than or equal to 50 in increments of 1 or Null.
Model Input
PreparedModelContainer
Indicates the container in which a Model[Sample] specified as input to the experiment function will be prepared.
Default Calculation: If PreparedModelAmount is set to All and when the input model has a product associated with both Amount and DefaultContainerModel populated, automatically set to the DefaultContainerModel value in the product. Otherwise set to Model[Container, Vessel, "2mL Tube"].
PreparedModelAmount
Indicates the amount of a Model[Sample] specified as input to the experiment function that will be prepared in the PreparedModelContainer. When set to All and the input model sample is not preparable, the entire amount of the input model sample that comes from one of the Products is prepared. The selected product must have both Amount and DefaultContainerModel populated, and it must not be a KitProduct. When set to All and the input model is preparable such as water, 1 Milliliter of the input model sample is prepared.
Programmatic Pattern: ((RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All) | Automatic) | Null
Post Experiment
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.
Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
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 Calculation: Resolves to True if any of the corresponding Incubation options are set. Otherwise, resolves to False.
IncubationTemperature
Temperature at which the SamplesIn should be incubated for the duration of the IncubationTime prior to starting the experiment.
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: ((Ambient | RangeP[$MinIncubationTemperature, $MaxIncubationTemperature]) | Automatic) | Null
IncubationTime
Duration for which SamplesIn should be incubated at the IncubationTemperature, prior to starting the experiment.
Mix
Default Calculation: Automatically resolves to True if any Mix related options are set. Otherwise, resolves to False.
MixType
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.
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 Calculation: Automatically resolves to True if MaxIncubationTime or MaxNumberOfMixes is set.
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 Calculation: Automatically resolves based on MixType, MixUntilDissolved, and the container of the given sample.
IncubationInstrument
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.
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.
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.
Programmatic Pattern: ((ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic) | Null
IncubateAliquotDestinationWell
The desired position in the corresponding IncubateAliquotContainer in which the aliquot samples will be placed.
Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
IncubateAliquot
The amount of each sample that should be transferred from the SamplesIn into the IncubateAliquotContainer when performing an aliquot before incubation.
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.
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 Calculation: Resolves to True if any of the corresponding Centrifuge options are set. Otherwise, resolves to False.
CentrifugeInstrument
Pattern Description: An object of type or subtype Model[Instrument, Centrifuge] or Object[Instrument, Centrifuge] or Null.
Programmatic Pattern: (ObjectP[{Model[Instrument, Centrifuge], Object[Instrument, Centrifuge]}] | Automatic) | Null
CentrifugeIntensity
The rotational speed or the force that will be applied to the samples by centrifugation prior to starting the experiment.
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: ((GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration]) | Automatic) | Null
CentrifugeTime
CentrifugeTemperature
The temperature at which the centrifuge chamber should be held while the samples are being centrifuged prior to starting the experiment.
Pattern Description: Ambient or greater than or equal to -10 degrees Celsius and less than or equal to 40 degrees Celsius or Null.
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.
Programmatic Pattern: ((ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic) | Null
CentrifugeAliquotDestinationWell
The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
Default Calculation: Automatically resolves to A1 in containers with only one position. For plates, fills wells in the order provided by the function AllWells.
CentrifugeAliquot
The amount of each sample that should be transferred from the SamplesIn into the CentrifugeAliquotContainer when performing an aliquot before centrifugation.
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.
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).
AliquotAmount
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.
Programmatic Pattern: ((RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All) | Automatic) | Null
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.
TargetConcentrationAnalyte
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.
AssayVolume
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.
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.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
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 Calculation: If ConcentratedBuffer is specified, automatically set to the ConcentratedBufferDilutionFactor of that sample; otherwise, set to Null.
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 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.
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 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.
AliquotSampleStorageCondition
The non-default conditions under which any aliquot samples generated by this experiment should be stored after the protocol is completed.
Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
DestinationWell
The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
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 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
Default Calculation: Automatic resolution will occur based on manipulation volumes and container types.
ConsolidateAliquots
Sample Preparation
PreparatoryUnitOperations
Specifies a sequence of transferring, aliquoting, consolidating, or mixing of new or existing samples before the main experiment. These prepared samples can be used in the main experiment by referencing their defined name. For more information, please reference the documentation for ExperimentSamplePreparation.
Protocol Options
Organizational Information
Template
A template protocol whose methodology should be reproduced in running this experiment. Option values will be inherited from the template protocol, but can be individually overridden by directly specifying values for those options to this Experiment function.
Pattern Description: An object of type or subtype Object[Protocol] or an object of type or subtype of Object[Protocol] with UnresolvedOptions, ResolvedOptions specified or Null.
Programmatic Pattern: (ObjectP[Object[Protocol]] | FieldReferenceP[Object[Protocol], {UnresolvedOptions, ResolvedOptions}]) | Null
Name
A object name which should be used to refer to the output object in lieu of an automatically generated ID number.
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.
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.
ImageSample
Example Calls
Filtration Type
Samples with volumes between 2 and 50 milliliters will be filtered using a syringe and syringe filter:
Sample with volumes larger than 50mL will be filtered using a peristaltic pump and a filter housing:
Sample with volumes between 50mL and 4L will be filtered using vacuum pump and a bottle top vacuum cap if Sterile has been specified True:
Filter Properties
Use the MolecularWeightCutOff option to select a filter that will remove particles larger than the chosen size:
Retentate washing and Resuspension
Preferred Input Containers
Warnings and Errors
Messages (58)
CentrifugeFilterDestinationRequired (1)
CollectionContainerPlateMismatch (1)
FilterInletConnectionType (1)
FilterMaxVolume (1)
FilterOptionMismatch (1)
FilterPlateDimensionsExceeded (2)
FilterPositionDestinationWellConflict (1)
FilterPositionDoesNotExist (1)
FilterPositionInvalid (1)
FilterUntilDrainedIncompatibleWithFilterType (1)
FiltrationTypeAndFilterHousingMismatch (2)
FiltrationTypeAndInstrumentMismatch (1)
FiltrationTypeAndSyringeMismatch (1)
FiltrationTypeMismatch (3)
IncompatibleFilterTimes (1)
LabelContainerOutIndexMismatch (2)
For all values of RetentateContainerLabel that are replicated, the corresponding integer indices in RetentateContainerOut are also be replicated in the same positions:
For all values of FiltrateContainerLabel that are replicated, the corresponding integer indices in FiltrateContainerOut are also be replicated in the same positions:
MissingVolumeInformation (1)
NoFilterAvailable (1)
NoUsableCentrifuge (1)
NumberOfFilterPrewettingsTooHigh (1)
ObjectDoesNotExist (6)
Throw a message if we have a sample that does not exist (name form):
Throw a message if we have a container that does not exist (name form):
Throw a message if we have a sample that does not exist (ID form):
Throw a message if we have a container that does not exist (ID form):
Do NOT throw a message if we have a simulated sample but a simulation is specified that indicates that it is simulated:
Do NOT throw a message if we have a simulated container but a simulation is specified that indicates that it is simulated:
OccludingRetentateMismatch (1)
OccludingRetentateNotSupported (1)
PoreSizeAndMolecularWeightCutoff (3)
PrefilterOptionsMismatch (1)
PrewetFilterCentrifugeIntensityTypeMismatch (1)
PrewetFilterIncompatibleWithFilterType (1)
PrewetFilterMismatch (1)
ResuspensionVolumeTooHigh (1)
RetentateCollectionContainerMismatch (1)
RetentateCollectionMethodPlateError (1)
RetentateCollectionMethodTransferMismatch (1)
RetentateWashCentrifugeIntensityTypeMismatch (3)
An error will be thrown if RetentateWashCentrifugeIntensity is specified but FiltrationType is not Centrifuge:
An error will be thrown if RetentateWashCentrifugeIntensity is specified but FiltrationType is not Centrifuge:
An error will be thrown if RetentateWashMix is False but the other RetentateWashMix options are specified:
SterileContainerRecommended (1)
SterileOptionMismatch (1)
TargetLabelMismatch (2)
If Target -> Retentate, then RetentateLabel and SampleOutLabel must be the same value; if Target -> Filtrate, then FiltrateLabel and SampleOutLabel must be the same value:
If Target -> Retentate, then RetentateContainerLabel and ContainerOutLabel must be the same value; if Target -> Filtrate, then FiltrateContainerLabel and ContainerOutLabel must be the same value:
UnusableCentrifuge (1)
VolumeTooLargeForCollectionContainer (1)
VolumeTooLargeForContainerOut (2)
If the provided FiltrateContainerOut option was for a container which MaxVolume is less then the volume of the sample, then an appropriate container will be picked and a message will be shown:
If the volume of the sample + the retentate washes is too large for the collection container, don't throw an error because we'll just move the liquid to a different container between cycles so it can fit:
VolumeTooLargeForSyringe (1)
Possible Issues
Last modified on Thu 4 Sep 2025 17:57:10