ExperimentCountLiquidParticles
ExperimentCountLiquidParticles[Samples]⟹Protocol
generates a Protocol object to run a high accuracy light obscuration (HIAC) experiment to count liquid particles of different sizes.
A sample with particles in a colloid or a very fine suspension is generally transparent, in contrast to a slurry sample, which is opaque. Light is scattered when passing a medium containing small suspended particles. Tracking the scatter of the light can help us count the number of particles at specific sizes in the sample. In the ExperimentCountLiquidParticles, the liquid sample is firstly placed in the sample deck, with the probe merged into the liquid. Then, pulling by the integrated syringe and a syringe pump, the liquid sample will pass the detector, where a light obscuration sensor scans the sample. The number of particles passed the sensor is calculated by measuring the corresponding electric voltage changes.
Experimental Principles
Instrumentation
HIAC 9703 Plus
Figure 2.1.1: A HIAC 9703 Plus liquid particle counter uses an installed syringe pump to pull the liquid sample from the container. When the liquid sample passes the flow cell, the laser from the laser diode will pass the sample. A photon detector will track the resulting scattered lights (by voltage changes) at preset particle sizes. The sample is then disposed of when the experiment is finished. The sample can be gently heated up during the experiment and stirred by a magnetic stir bar (50 to 350 RPM) during the measurement.
Experiment Options
General
Instrument
The instrument used to detect and count particles in a sample using light obscuration while flowing the sample through a flow cell.
Pattern Description: An object of type or subtype Model[Instrument, LiquidParticleCounter] or Object[Instrument, LiquidParticleCounter]
Programmatic Pattern: ObjectP[{Model[Instrument, LiquidParticleCounter], Object[Instrument, LiquidParticleCounter]}]
Sensor
The light obscuration sensor that measures the reduction in light intensity and processes the signal to determine particle size and count. The sensor sets the range of the particle sizes that can be detected.
Pattern Description: An object of type or subtype Object[Part, LightObscurationSensor] or Model[Part, LightObscurationSensor]
Programmatic Pattern: ObjectP[{Object[Part, LightObscurationSensor], Model[Part, LightObscurationSensor]}]
Syringe
The syringe installed on the instrument sampler used to draw the liquid through the light obscuration sensor and out of the system.
SyringeSize
The size of the syringe installed on the instrument sampler used to draw the liquid through the light obscuration sensor and flush it back out.
Default Calculation: Automatically set to the 1 mL syringe if the sample volume is less and equal than 5 mL, and the 10 mL syringe otherwise.
Method
The light obscuration standard procedure method object that describes the conditions for liquid particle counting. See figure x.x for examples of some standard methods.
Pattern Description: An object of type or subtype Object[Method, LiquidParticleCounting] or Custom or Null.
ParticleSizes
The collection of ranges (5 Micrometer to 100 Micromter) the different particle sizes that monitored.
Pattern Description: Greater than or equal to 1 micrometer and less than or equal to 100 micrometers or list of one or more greater than or equal to 1 micrometer and less than or equal to 100 micrometers entries or Null.
Programmatic Pattern: (({RangeP[1*Micrometer, 100*Micrometer]..} | RangeP[1*Micrometer, 100*Micrometer]) | Automatic) | Null
NumberOfReplicates
The number of times to repeat measurements on each provided sample(s). If Aliquot -> True, this also indicates the number of times each provided sample will be aliquoted.
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. For now ExperimentCountLiquidParticles can be only done manually.
Particle Size Measurements
SaveCustomMethod
Automatically set to True if Method is Custom, or if Method is specified, but any related option value is changed.
SampleTemperature
Pattern Description: Ambient or greater than or equal to 0 degrees Celsius and less than or equal to 80 degrees Celsius.
EquilibrationTime
The length of time for which each sample is incubated at the requested SampleTemperature just prior to being read.
Default Calculation: Automatically set to 5 minutes when SampleTemperature is anything other than Ambient.
NumberOfReadings
The number of times the liquid particle count is read by passing ReadingVolume through the light obscuration sensor.
PreRinseVolume
The volume of the sample flown into the syringe tubing to rinse out the lines with each new sample before beginning the reading.
Default Calculation: Automatically set to 0 if DiscardFirstRun is True, otherwise set to the max volume for the syringe.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 10 milliliters or Null.
DiscardFirstRun
Indicate during the data collection, the data collection starts from the 2nd reading, the first reading will be discarded. Setting this to true will increase the reproducibility of data collection.
SamplingHeight
Indicate during the data collection, the distance between the tip of the probe and the bottom of the container.
Default Calculation: Automatically set based on the dimension of the container of the SamplesIn and StirBar (if AcquisitionMixType is Stir).
Pattern Description: Greater than or equal to 1 millimeter and less than or equal to 95 millimeters.
AcquisitionMix
AcquisitionMixType
Indicates the method used to mix the sample. If this option is set to Stir, a StirBar will be transferred into the sample container and stir the sample during the entire data collection process.
Programmatic Pattern: (If[$CountLiquidParticlesAllowHandSwirl, Stir | Swirl, Alternatives[Stir]] | Automatic) | Null
StirBar
Default Calculation: Automatically set based on the volume and the container of the sample if the AcquisitionMixType is Stir.
Pattern Description: An object of type or subtype Model[Part, StirBar] or Object[Part, StirBar] or Null.
AcquisitionMixRate
Pattern Description: Greater than or equal to 50 revolutions per minute and less than or equal to 350 revolutions per minute or Null.
AdjustMixRate
When using a stir bar for AcquisitionMixType is Stir, if specified AcquisitionMixRate does not provide a stable or consistent circular rotation of the magnetic bar, indicates if mixing should continue up to MaxStirAttempts in attempts to stir the samples. If stir bar is wiggling, decrease AcquisitionMixRate by AcquisitionMixRateIncrement and check if the stir bar is still wiggling. If it is, decrease by AcquisitionMixRateIncrement again. If still wiggling, repeat decrease until MaxStirAttempts. If the stir bar is not moving/stationary, increase the AcquisitionMixRate by AcquisitionMixRateIncrement and check if the stir bar is still stationary. If it is, increase by AcquisitionMixRateIncrement again. If still stationary, repeat increase until MaxStirAttempts. Mixing will occur during data acquisition. After MaxStirAttempts, if stable stirring was not achieved, StirringError will be set to True in the protocol object.
MinAcquisitionMixRate
Sets the lower limit stirring rate to be decreased to for sample mixing while attempting to mix the samples with a stir bar if AdjustMixRate is True.
Default Calculation: Automatically sets to 20% RPM lower than AcquisitionMixRate if AdjustMixRate is True.
Pattern Description: Greater than or equal to 50 revolutions per minute and less than or equal to 350 revolutions per minute or Null.
MaxAcquisitionMixRate
Sets the upper limit stirring rate to be increased to for sample mixing while attempting to mix the samples with a stir bar if AdjustMixRate is True.
Default Calculation: Automatically sets to 20% RPM greater than AcquisitionMixRate if AdjustMixRate is True.
Pattern Description: Greater than or equal to 50 revolutions per minute and less than or equal to 350 revolutions per minute or Null.
AcquisitionMixRateIncrement
Indicates the value to increase or decrease the mixing rate by in a stepwise fashion while attempting to mix the samples with a stir bar.
Pattern Description: Greater than or equal to 10 revolutions per minute and less than or equal to 350 revolutions per minute or Null.
MaxStirAttempts
Indicates the maximum number of attempts to mix the samples with a stir bar. One attempt designates each time AdjustMixRate changes the AcquisitionMixRate (i.e. each decrease/increase is equivalent to 1 attempt.
Priming
PrimeSolutions
The solution(s) pumped through the instrument's flow path prior to the loading and measuring samples.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample.
PrimeSolutionTemperatures
For each member of PrimeSolutions, the temperature to which the PrimeSolutions is preheated before flowing it through the flow path.
Pattern Description: Ambient or greater than or equal to 0 degrees Celsius and less than or equal to 80 degrees Celsius or Null.
PrimeEquilibrationTime
For each member of PrimeSolutions, the length of time for which the prime solution container equilibrate at the requested PrimeSolutionTemperatures in the sample rack before being pumped through the instrument's flow path.
Default Calculation: Automatically set to 5 minutes if the PrimeSolutionTemperatures is not Ambient.
PrimeWaitTime
For each member of PrimeSolutions, the amount of time for which the syringe is allowed to soak with each prime solutions before flushing it to the waste.
NumberOfPrimes
For each member of PrimeSolutions, the number of times each prime solution pumped through the instrument's flow path.
Sample Preparation
DilutionCurve
The collection of dilutions that will be performed on the samples before light obscuration measurements are taken. For Fixed Dilution Volume Dilution Curves, the Sample Amount is the volume of the sample that will be mixed with the Diluent Volume of the Diluent to create the desired concentration. For Fixed Dilution Factor Dilution Curves, the Sample Volume is the volume of the sample that will created after being diluted by the Dilution Factor. For example, a 1M sample with a dilution factor of 0.7 will be diluted to a concentration 0.7M. IMPORTANT: Because the dilution curve does not intrinsically include the original sample, in the case of sample dilution the first diluting factor should be 1 or Diluent Volume should be 0 Microliter to include the original sample. If dilutions and injections are specified, injection samples will be injected into every dilution in the curve corresponding to SamplesIn.
Default Calculation: This is automatically set Null if Diluent is set to Null or a SerialDilutionCurve is specified. Otherwise will default to a 0.5 factor dilution.
Programmatic Pattern: (({{RangeP[0*Microliter, $MaxTransferVolume], RangeP[0*Microliter, $MaxTransferVolume]}..} | {{RangeP[0*Microliter, $MaxTransferVolume], RangeP[0, 1]}..}) | Automatic) | Null
SerialDilutionCurve
The collection of serial dilutions that will be performed on the samples before light obscuration measurements are taken. For Serial Dilution Volumes, the Transfer Volume is taken out of the sample and added to a second well with the Diluent Volume of the Diluent. It is mixed, then the Transfer Volume is taken out of that well to be added to a third well. This is repeated to make Number Of Dilutions diluted samples. For example, if a 100 ug/ ml sample with a Transfer Volume of 20 Microliters, a Diluent Volume of 60 Microliters and a Number of Dilutions of 3 is used, it will create a DilutionCurve of 25 ug/ ml, 6.25 ug/ ml, and 1.5625 ug/ ml with each dilution having a volume of 60 Microliters. For Serial Dilution Factors, the sample will be diluted by the dilution factor at each transfer step. IMPORTANT: Because the dilution curve does not intrinsically include the original sample, in the case of sample dilution the first diluting factor should be 1 or Diluent Volume should be 0 Microliter to include the original sample. If dilutions and injections are specified, injection samples will be injected into every dilution in the curve corresponding to SamplesIn.
Default Calculation: This is automatically set to Null if Diluent is set to Null or a non-serial Dilution Curve is specified. In all other cases it is automatically set to TransferVolume as one tenth of smallest of sample volume or container max volume, DiluentVolume as smallest of sample volume or container max volume, and Number of Dilutions as 3.
Programmatic Pattern: (({RangeP[0*Microliter, $MaxTransferVolume], RangeP[0*Microliter, $MaxTransferVolume], RangeP[1, 12, 1]} | {RangeP[0*Microliter, $MaxTransferVolume], {RangeP[0, 1], RangeP[1, 12, 1]} | {RangeP[0, 1]..}}) | Automatic) | Null
Diluent
Default Calculation: Automatically set to the Solvent of the sample if DilutionCurve or SerialDilutionCurve are specified and if the Solvent field is not informed, Diluent is set to Model[Sample,"Milli-Q water"]. Otherwise set to Null.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
DilutionContainer
The containers in which each sample is diluted with the Diluent to make the concentration series, with indices indicating specific grouping of samples if desired.
Default Calculation: Automatically set as Model[Container,Plate,"96-well 2mL Deep Well Plate"], grouping samples with the same container and DilutionStorageCondition.
Pattern Description: List of one or more an object of type or subtype Model[Container] or Null entries or Null.
DilutionStorageCondition
The conditions under which any leftover samples from the DilutionCurve should be stored after the samples are transferred to the measurement plate.
Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
DilutionMixVolume
The volume that is pipetted out and in of the dilution to mix the sample with the Diluent to make the DilutionCurve.
Default Calculation: Automatically set to the smallest dilution volume or half the largest dilution volume, whichever one is smaller.
Pattern Description: Greater than or equal to 0 microliters and less than or equal to 900 microliters or Null.
DilutionNumberOfMixes
The number of pipette out and in cycles that is used to mix the sample with the Diluent to make the DilutionCurve.
Pattern Description: Greater than or equal to 0 and less than or equal to 20 in increments of 1 or Null.
DilutionMixRate
The speed at which the DilutionMixVolume is pipetted out and in of the dilution to mix the sample with the Diluent to make the DilutionCurve.
Default Calculation: Automatically set to 100 Microliter/Second if the sample is diluted and Null otherwise.
Pattern Description: Greater than or equal to 0.4 microliters per second and less than or equal to 500 microliters per second or Null.
Measurement
ReadingVolume
The volume of sample that is loaded into the instrument and used to determine particle size and count. If the reading volume exceeds the volume of the syringe the instruments will perform multiple strokes to cover the full reading volume.
Default Calculation: Automatically set based on speficied Method. If Method is Custom, automatically set to 20 Microliter if Syringe size is 1 mL, or 200 Microliter otherwise.
Washing
WashSolution
For each member of SamplesIn, the solution pumped through the instrument's flow path to clean it between the loading of each new sample.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample.
WashSolutionTemperature
For each member of SamplesIn, the temperature to which the WashSolution is preheated before flowing it through the flow path.
Pattern Description: Ambient or greater than or equal to 4 degrees Celsius and less than or equal to 40 degrees Celsius.
WashEquilibrationTime
For each member of SamplesIn, the length of time for which the wash solution container equilibrate at the requested WashSolutionTemperature in the sample rack before being pumped through the instrument's flow path.
WashWaitTime
For each member of SamplesIn, the amount of time for which the syringe is allowed to soak with each wash solution before flushing it to the waste.
NumberOfWashes
For each member SamplesIn, the number of times each wash solution is pumped through the instrument's flow path.
Model Input
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: ((Null | (RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All)) | Automatic) | Null
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 the input model has a product associated with both Amount and DefaultContainerModel populated, automatically set to the DefaultContainerModel value in the product. Otherwise, automatically set to Model[Container, Vessel, "50mL Tube"].
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.
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
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.
Pattern Description: List of one or more unit Operation ManualSamplePreparation or RoboticSamplePreparation or unit Operation must match SamplePreparationP entries or Null.
Programmatic Pattern: {((ManualSamplePreparationMethodP | RoboticSamplePreparationMethodP) | SamplePreparationP)..} | Null
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.
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 Calculation: Resolves to True if any of the corresponding Filter options are set. Otherwise, resolves to False.
FiltrationType
Default Calculation: Will automatically resolve to a filtration type appropriate for the volume of sample being filtered.
FilterInstrument
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: (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
Filter
The filter that should be used to remove impurities from the SamplesIn prior to starting the experiment.
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: (ObjectP[{Model[Container, Plate, Filter], Model[Container, Vessel, Filter], Model[Item, Filter]}] | Automatic) | Null
FilterMaterial
The membrane material of the filter that should be used to remove impurities from the SamplesIn prior to starting the experiment.
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.
PrefilterMaterial
The material from which the prefilter filtration membrane should be made of to remove impurities from the SamplesIn prior to starting the experiment.
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.
FilterPoreSize
The pore size of the filter that should be used when removing impurities from the SamplesIn prior to starting the experiment.
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.
PrefilterPoreSize
The pore size of the filter; all particles larger than this should be removed during the filtration.
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.
FilterSyringe
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: ((ObjectP[{Model[Container, Syringe], Object[Container, Syringe]}] | _String) | Automatic) | Null
FilterHousing
The filter housing that should be used to hold the filter membrane when filtration is performed using a standalone filter membrane.
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: (ObjectP[{Model[Instrument, FilterHousing], Object[Instrument, FilterHousing], Model[Instrument, FilterBlock], Object[Instrument, FilterBlock]}] | Automatic) | Null
FilterIntensity
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: ((GreaterP[0*RPM] | GreaterP[0*GravitationalAcceleration]) | Automatic) | Null
FilterTime
Default Calculation: Will automatically resolve to 5 Minute if FiltrationType is Centrifuge and Filtration is True.
FilterTemperature
The temperature at which the centrifuge chamber will be held while the samples are being centrifuged during filtration.
Default Calculation: Will automatically resolve to 22 Celsius if FiltrationType is Centrifuge and Filtration is True.
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 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: (((ObjectP[{Model[Container], Object[Container]}] | _String) | {GreaterEqualP[1, 1] | Automatic, (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic) | Null
FilterAliquotDestinationWell
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.
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.
Programmatic Pattern: ((ObjectP[Model[Container]] | {GreaterEqualP[1, 1] | (Automatic | Null), (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic) | Null
FilterAliquot
The amount of each sample that should be transferred from the SamplesIn into the FilterAliquotContainer when performing an aliquot before filtration.
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.
FilterSterile
Default Calculation: Resolve to False if Filtration is indicated. If sterile filtration is desired, this option must manually be set to True.
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
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
Warnings and Errors
Messages (21)
CountLiquidParticleDilutionContainerLengthMismatch (1)
CountLiquidParticleInvalidSamplingHeight (1)
CountLiquidParticleLiquidLevelTooLow (1)
CountLiquidParticleRequiredAcquisitionMixOptions (2)
CountLiquidParticlesDuplicateParticleSizes (1)
CountLiquidParticleUnneededAcquisitionMixOptions (1)
CountLiquidParticleUnneededAdjustMixOptions (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:
Possible Issues
Particle Count Saturation
The sensor has a saturation limit of 5000 particles per count. The number of particle counts will not increase after reaching this limit. Therefore, reducing ReadingVolume will reduce the number of particles passing the sensor for each reading cycle.
Stirring A Non-Self-Standing Tube
Last modified on Sat 16 Aug 2025 15:26:37