ExperimentDynamicFoamAnalysis
ExperimentDynamicFoamAnalysis[Samples]⟹Protocol
generates a Protocol object for running an experiment to characterize foam generation and decay for Samples over time.
Dynamic Foam Analysis is a technique that provides information on the foamability, stability, drainage process, and structure of liquid-based foams throughout the processes of foam generation and decay. A liquid sample is injected into a column, and then agitated to generate foam via either mixing with impeller blades or bubbling of gas through a glass filter plate. The stability and structural characteristics of the resulting foam can be monitored over time, by continuously recording the heights of the foam and liquid columns, the sizes and distributions of foam bubbles, and the liquid content of the foam at various positions along the foam column.
Experimental Principles
Figure 1.1: Step 1: The selected foam column is set up with the selected modules necessary to perform the experiment. This includes agitation modules (sparge filter or stir blade), the temperature probe module, and any detection modules (imaging module, liquid conductivity module) that have been selected. Step 2: A syringe and needle are used to transfer the sample to the foam column. The tip of the needle is lightly swirled around the interior edge of the foam column to wet the sides of the column. The sample is added at a slow, steady rate to avoid generating bubbles. Step 3: The column is loaded onto the instrument and sample measurements are taken over time. Step 4: The foam data is analyzed and visualized.
Instrumentation
DFA 100
Figure 2.1.1: Instrument diagram for the Dynamic Foam Analysis system: Three different detection methods are available, as listed in the table. Modules related to each form of detection method can be installed in and around the column, as depicted in the side and top view diagrams. The height method involves using the difference in light penetration to distinguish the heights of foam, liquid, and air. A light source and contact-free optical sensors are located opposite of each other, surrounding the foam column. The liquid conductivity method involves measuring the liquid content of the foam at 7 positions. Two liquid conductivity module probes are inserted into the foam column for the sensors to directly measure the conductivity of the liquid present. The imaging method captures images of the 2-dimensional cross section of foam along the edge of the foam column. Light is shone through a glass prism, and the differences in diffraction of light allow for the determination of bubble size, bubble distribution, and bubble radius.
Experiment Options
General
Instrument
Pattern Description: An object of type or subtype Model[Instrument, DynamicFoamAnalyzer] or Object[Instrument, DynamicFoamAnalyzer]
Programmatic Pattern: ObjectP[{Model[Instrument, DynamicFoamAnalyzer], Object[Instrument, DynamicFoamAnalyzer]}]
SampleVolume
Default Calculation: If no options are provided, will default to the minimum volume allowed for the foam column.
Pattern Description: Greater than or equal to 0 milliliters and less than or equal to 100 milliliters.
Temperature
The temperature at which the foam column containing the sample will be heated to during the duration of the experiment.
Pattern Description: Ambient or greater than or equal to 4 degrees Celsius and less than or equal to 90 degrees Celsius.
NumberOfReplicates
Number of times each of the input samples should be analyzed using identical experimental parameters.
Method
TemperatureMonitoring
Indicates whether the sample temperature will be directly measured during the experiment, using a temperature probe inserted into the foam column.
Default Calculation: If no options are provided, will default to True unless a Liquid Content Module is used or Agitation is Stir, in which case it will default to False.
DetectionMethod
The type of foam detection method(s) that will be used during the experiment. The foam detection methods are the Height Method (default method for the Dynamic Foam Analyzer), Liquid Conductivity Method, and Imaging Method. The Height Method provides information on foamability and foam height, the Liquid Conductivity Method provides information on the liquid content and drainage dynamics of foam, and then Imaging Method provides data on the size and distribution of foam bubbles.
Default Calculation: If no options are provided, will default to the appropriate method(s) based on the experimental options selected. Height Method is always selected.
Pattern Description: List of one or more HeightMethod, ImagingMethod, or LiquidConductivityMethod entries.
FoamColumn
Default Calculation: If no options are provided, will default based on temperature/method requirements. If the detection method is the Foam Imaging Method, the column will default to a Foam Imaging Module-compatible column. If temperature measurements are required, the column will default to a double-jacketed temperature column.
Pattern Description: An object of type or subtype Object[Container, FoamColumn] or Model[Container, FoamColumn]
Programmatic Pattern: ObjectP[{Object[Container, FoamColumn], Model[Container, FoamColumn]}] | Automatic
FoamColumnLoading
Indicates whether the foam column will be pre-wetted when the sample is loaded during the experiment. Wet indicates that the sides of the foam column will be wetted with the sample during sample loading. Dry indicates that the sample will be directly loaded to the bottom of the foam column, and the sides of the column will be left dry.
Detectors
LiquidConductivityModule
The Liquid Conductivity Module object that will be used in the experiment if the Liquid Conductivity Method is selected. The Liquid Conductivity Module is an attachment for the Dynamic Foam Analyzer instrument that provides information on the liquid content and drainage dynamics over time at various positions along the foam column; this is achieved by recording changes in conductivity of the foam over time, which provides information on the amount of liquid vs gas that is present. This module can only be selected if the sparge agitation method is used, as the module is incompatible with stir blades.
Default Calculation: If no options are provided, will default to the appropriate object based on the experimental options selected.
Pattern Description: An object of type or subtype Object[Part, LiquidConductivityModule] or Model[Part, LiquidConductivityModule] or Null.
Programmatic Pattern: (ObjectP[{Object[Part, LiquidConductivityModule], Model[Part, LiquidConductivityModule]}] | Automatic) | Null
FoamImagingModule
The Foam Imaging Module object that will be used in the experiment if the Imaging Method is selected. The Foam Imaging Module transmits light through a glass prism specially fitted on the side of a foam column, in order to ascertain the 2D structure of the foam based on the principles of total reflection. Since glass and liquid have comparable diffractive indices, light that hits a foam lamella will be partially diffracted and transmitted into the foam. On the other hand, glass and air have different diffractive indices, so light that hits within the air bubble will be fully reflected and sensed by the camera, allowing for construction of a 2D image of the layer of foam located at the edge of the prism.
Default Calculation: If no options are provided, will default to the appropriate object based on the experimental options selected.
Pattern Description: An object of type or subtype Object[Part, FoamImagingModule] or Model[Part, FoamImagingModule] or Null.
Programmatic Pattern: (ObjectP[{Object[Part, FoamImagingModule], Model[Part, FoamImagingModule]}] | Automatic) | Null
CameraHeight
The height along the column at which the camera used by the Foam Imaging Module will be positioned during the experiment if the Imaging Method is selected.
Pattern Description: Greater than or equal to 55 millimeters and less than or equal to 260 millimeters or Null.
StructureIlluminationIntensity
The illumination intensity that will be used for foam structure detection by the Foam Imaging Module if the Imaging Method is selected. This refers to the intensity at which the light is shone through the sample.
Pattern Description: Greater than or equal to 0 percent and less than or equal to 100 percent or Null.
FieldOfView
The size of the surface area that is observable at any given moment by the camera used by the Foam Imaging Module in the experiment if the Imaging Method is selected.
Default Calculation: If no options are provided, will default to 140 millimeters squared if the Imaging Method is selected.
Decay
Wavelength
The wavelength type that will be transmitted through the foam column and detected by the default Diode Array Module during the experiment. Two wavelength types are possible, visible (469 nanometer) and infrared (850 nanometer).
Default Calculation: If no options are provided, will default to visible light if Height Method detection is selected.
HeightIlluminationIntensity
The illumination intensity that will be used for foam height detection by the Diode Array Module. This refers to the intensity at which the light is shone through the sample.
Default Calculation: If no options are provided, will default to 100% if Height Method detection is selected.
DecayTime
The amount of time the dynamic foam analysis experiment will allow the foam bubbles to drain and coalesce, during which experimental measurements will be taken.
DecaySamplingFrequency
The data sampling frequency during the period in which the foam column undergoes decay, involving liquid draining, bubble coalescence, and foam column height decrease. The data recorded for the Height Method are the foam and liquid heights over time. The data recorded for the Imaging Method are timelapse 2D snapshots of the foam in the camera field of view. The data recorded for the Liquid Conductivity Method are the resistances at sensors spaced along the length of the foam column.
Agitation
Agitation
The type of agitation (sparging or stirring) that will be used to generate foam during the experiment.
Default Calculation: If no options are provided, will default based on whether any Stir or Sparge-related options are chosen. If all are Automatic, will default to Stir. Note that if Stir is selected, the Liquid Conductivity Module cannot be used.
AgitationTime
The amount of time the dynamic foam analysis experiment will agitate the sample to induce the production of foam.
Pattern Description: Greater than 0 minutes and less than or equal to 72 hours in increments of 1 second.
AgitationSamplingFrequency
The data sampling frequency during the agitation period in which foam is made. The data recorded for the Height Method are the foam and liquid heights over time. The data recorded for the Imaging Method are timelapse 2D snapshots of the foam in the camera field of view. The data recorded for the Liquid Conductivity Method are the resistances at sensors spaced along the length of the foam column.
SpargeFilter
The sparging filter that will be used to introduce gas bubbles into the column during foam generation. The filter is a glass plate with pores for bubble generation. The size of the filter must match the size of the column selected in order to only flow gas within the confines of the column.
Default Calculation: If no options are provided, will default based on the size of the foam column used in the experiment if agitation is set to sparge.
Pattern Description: An object of type or subtype Object[Part, SpargeFilter] or Model[Part, SpargeFilter] or Null.
Programmatic Pattern: (ObjectP[{Object[Part, SpargeFilter], Model[Part, SpargeFilter]}] | Automatic) | Null
SpargeGas
The sparging gas that will be used during foam generation in the experiment if agitation is set to sparge.
Default Calculation: If no options are provided, will default to Air in the experiment if agitation is set to sparge.
SpargeFlowRate
The flow rate of the sparging gas that will be used during foam generation in the experiment if agitation is set to sparge.
Default Calculation: If no options are provided, will default to 1 Liter/Minute in the experiment if agitation is set to sparge.
Pattern Description: Greater than or equal to 0.2 liters per minute and less than or equal to 1 liter per minute or Null.
StirBlade
The stir blade that will be used during foam generation in the experiment if agitation is set to stir.
Default Calculation: If no options are provided, will default to stir blade in the experiment if agitation is set to stir.
Pattern Description: An object of type or subtype Object[Part, StirBlade] or Model[Part, StirBlade] or Null.
Programmatic Pattern: (ObjectP[{Object[Part, StirBlade], Model[Part, StirBlade]}] | Automatic) | Null
StirRate
The stir rate of the stir blade that will be used during foam generation in the experiment if agitation is set to stir.
Default Calculation: If no options are provided, will default to 5000 RPM in the experiment if agitation is set to stir.
Pattern Description: Greater than or equal to 0 revolutions per minute and less than or equal to 8000 revolutions per minute or Null.
StirOscillationPeriod
The oscillation period setting for the stir blade that will be used during foam generation in the experiment if agitation is set to stir. This refers to the time after which the stirring blade changes stirring direction.
Default Calculation: If no options are provided, will default to 0 second in the experiment if agitation is set to stir.
Pattern Description: Greater than or equal to 0 seconds and less than or equal to 59 seconds or Null.
Wash
NumberOfWashes
The number of washes that will be used to clean the column and/or the stir blade/filter plate after the experiment is run.
Default Calculation: If no options are provided, will default to the PreferredNumberOfWashes for the FoamColumn.
Pattern Description: Greater than or equal to 1 and less than or equal to 10 in increments of 1 or Null.
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, Oven} or Disposal 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.
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, Oven} 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
Perform a Dynamic Foam Analysis experiment
Specify the form of DetectionMethod used in the experiment
Specify the form of Agitation used in the experiment to create foam
Specify settings related to the detection method to be used in the experiment
Specify settings related to the agitation to be used in the experiment
Specify settings related to the time and data sampling frequencies to be used in the experiment
Specify settings related to the temperature to be used in the experiment
Warnings and Errors
Messages (28)
DFAAgitationMethodsMismatch (1)
DFAAgitationSamplingFrequencyLow (1)
DFAAgitationTime (1)
DFADecaySamplingFrequencyLow (1)
DFAHeightMethodRequiredMismatch (1)
DFAImagingColumnError (1)
DFAImagingMethodNullMismatch (1)
DFAImagingMethodOnlyMismatch (1)
DFALiquidConductivityMethodNullMismatch (1)
DFALiquidConductivityOnlyMismatch (1)
DFANumberOfWashesLow (1)
DFASampleVolumeFoamColumnError (1)
DFASpargeNullMismatch (1)
DFASpargeOnlyMismatch (1)
DFAstirLiquidConductivityMismatch (1)
DFAStirNullMismatch (1)
DFAStirOnlyMismatch (1)
DFATemperatureColumnError (1)
DFATemperatureMonitoringError (1)
ObjectDoesNotExist (6)
Do NOT throw a message if we have a simulated container but a simulation is specified that indicates that it is simulated:
Do NOT throw a message if we have a simulated sample but a simulation is specified that indicates that it is simulated:
Throw a message if we have a container that does not exist (ID 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 sample that does not exist (name form):
Possible Issues
Foam overflowing the foam column.
If the agitation is too long relative to the sparging flow rate or stir rate selected, too much foam may be generated, leading to the overflowing of the foam column and the subsequent abortion of the experiment. To avoid this, adjust either the AgitationTime, or the SpargeFlowRate/StirRate to be lower, to decrease the production of foam.
Insufficient foaming relative to the CameraHeight of the FoamImagingModule.
If the CameraHeight is set above the level of the foam generated in the experiment, no information on foam structure will be able to be collected. To avoid this, decrease the CameraHeight to be lower than the maximum foam height, or increase agitation to increase the production of foam.
Insufficient data points collected.
Last modified on Wed 3 Sep 2025 14:59:33