ExperimentKarlFischerTitration
ExperimentKarlFischerTitration[Samples]⟹Protocol
generates a Protocol to measure the water content of the provided Samples.
ExperimentKarlFischerTitration is a method for determining the water content of a given solid or liquid sample. This occurs by meausring the presence or consumption of molecular iodine as it is consumed though reaciton with water. In the case of Volumetric Karl Fischer titration, a sample is dissolved in a medium (usually methanol), and a mixture of iodine, sulfur dioxide, an organic base, and an organic solvent is added to it in small increments with a buret. Iodine in this mixture immediately reacts with water; once iodine begins to accumulate, further addition is stopped because all water has been consumed, and the water content of the source sample is calculated. In the case of Coulometric Karl Fischer titration, a sample is heated in a sealed tube, and its headspace gas is bubbled into a mixture of iodide ions, sulfur dioxide, an organic base, and an organic solvent. An electrode reduces iodide ions to molecular iodine, and the iodine reacts immediately with water. When iodine begins to accumulate, further reduction is stopped because all water has been consumed, and the water content of the source sample is calculated.
Experimental Principles
Figure 1.1: Procedural outline for ExperimentKarlFischerTitration: Step 1: If using a solid sample, grind the sample. A grinder can be specified by Grinder option. ECL offers three grinder types, including BallMill, KnifeMill, and MortarGrinders, which can be specified by GrinderType option. Refer to Table 2 for detailed information about the grinders available at ECL. Step 2: If SamplingMethod is set to Headspace (when Technique is set to Coulometric), the sample is heated in its sealed vials, and its headspace gas is bubbled into the reaction vessel. If SamplingMethod is set to Liquid (when Technique is set to Volumetric), the sample is added to the reaction vessel directly. Step 3: The titration occurs. If Technique is set to Volumetric, the KarlFischerReagent is added to the reaction vessel until iodine accumulates and the endpoint is reached. If Technique is set to Coulometric, the KarlFischerReagent is already in the reaction vessel, and an electrode reduces iodide ions to molecular iodide, which is consumed by the water, and the electrode continues reduction until iodine accumulates and the endpoint is reached. Step 4: Water content is computed by calculating how much water can react with a given volume of Karl Fischer reagent, and then measuring how much reagent is required to remove all water from the sample.
Instrumentation
Metrohm 901 Titrando
Figure 2.1.1: During Volumetric Karl Fischer titration, the sample is dissolved in the medium (usually methanol), and a mixture of iodine, sulfur dioxide, an organic base, and an organic solvent (KarlFischerReagent) is added in small increments with a buret. The iodine in this mixture reacts immediately with water, and addition continues until the electrode detects an accumulation of iodine. This indicates that all water has been consumed and further addition is stopped.
Metrohm 851 Titrando with generator electrode without diaphragm
Figure 2.2.1: During Coulometric Karl Fischer titration, a sample is heated in a sealed tube, and its headspace gas is bubbled into a mixture of iodide ions, sulfur dioxide, an organic base, and an organic solvent (KarlFischerReagent). An electrode reduces iodide ions to molecular iodine, and this iodine reacts immediately with water. This process continues until a separate electrode detects the accumulation of iodine. This indicates that all water released in the headspace gas has been consumed and further generation of iodine is stopped.
Experiment Options
General
Instrument
The instrument that is used to measure the water content of a sample by measuring the consumption of iodine in a Karl Fischer reaction.
Default Calculation: Automatically set to Model[Instrument, KarlFischerTitrator, "Metrohm 851 Titrando with generator electrode without diaphragm"] if Method is set to Coulometric, or Model[Instrument, KarlFischerTitrator, "Metrohm 901 Titrando"] if Method is set to Volumetric.
Pattern Description: An object of type or subtype Model[Instrument, KarlFischerTitrator] or Object[Instrument, KarlFischerTitrator]
Programmatic Pattern: ObjectP[{Model[Instrument, KarlFischerTitrator], Object[Instrument, KarlFischerTitrator]}] | Automatic
Technique
Indicates how the Karl Fischer reagent is introduced to the sample. If set to Volumetric, the Karl Fischer reagent mixture is introduced via a buret in small increments, and the amount of iodine consumed is measured via conductivity as liquid is introduced. If set to Coulometric, molecular iodine is generated in situ by applying a pulse of electric current to a sample of iodine anions, and the consumption of this generated iodine is measured via conductivity.
Default Calculation: Automatically set to the TitrationTechnique field of the specified Instrument model. If Instrument is not specified, automatically set to Volumetric if Temperature is set to Ambient, or SamplingMethod is set to Liquid, or a KarlFischerReagent is specified that contains molecular iodine, or Medium is specified, or Standard is set to a liquid standard, or GasFlowRate is set to Null, or if the input samples are Liquid. Otherwise, automatically set to Coulometric.
KarlFischerReagent
If set to Technique is set to Volumetric, the reagent mixture that is introduced to the sample. In order to measure water content, this mixture should contain iodine, sulfur dioxide, an organic solvent, and an organic base. If Technique is set to Coulometric, the mixture through which sample headspace is bubbled. Unlike Volumetric, this mixture should contain iodide ions instead of iodine.
Default Calculation: If Method is set to Volumetric, automatically set to Model[Sample, "HYDRANAL - Composite 5"]. If Method is set to Coulometric, automatically set to Model[Sample, "HYDRANAL - Coulomat AG-Oven"].
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or HydranalCoulomatAGOven, HydranalCoulomatAG, HydranalComposite5, HydranalComposite5K, HydranalComposite2, or HydranalComposite1.
Programmatic Pattern: (KarlFischerReagentP | (ObjectP[{Model[Sample], Object[Sample]}] | _String)) | Automatic
SampleAmount
Indicates the amount of sample to be added to the reaction chamber or headspace vial for their water content to be measured. If Grind is set to True, this is the amount of ground powder to be used. Note that if Temperature is set to Auto, this much sample will be used to determine the water release temperature, and then another sample of this same amount will be used to measure the water content.
Default Calculation: If input sample's State is Solid, automatically set to 100 Milligram or the total mass of the sample, whichever is smaller. If input sample's State is Liquid, automatically set to 1 Milliliter or the total volume of the sample, whichever is smaller.
Programmatic Pattern: (RangeP[10*Milligram, 100*Gram] | RangeP[10*Microliter, 100*Milliliter]) | Automatic
Sampling
SamplingMethod
The process by which the sample is introduced to the Karl Fischer reagent, or vice versa. If set to Liquid, then the Karl Fischer reagent is introduced to the sample directly. If set to Headspace, then the sample is heated to the specified Temperature and the released gas flows into the Karl Fischer reagent chamber and measured for water content.
Default Calculation: If Technique is set to Coulometric, SamplingMethod is automatically set to Headspace. If Technique is Volumetric, SamplingMethod is automatically set to Liquid.
Temperature
Indicates the temperature to which the sample is heated in order to release its water for Coulometric technique. The headspace gas is then carried into the reaction chamber according to GasFlowRate and water content is measured. If set to a temperature, the oven will heat the sample to that value and the headspace gas will be bubbled through the KarlFisherReagent in the reaction vessel. Can only be set to Ambient if Technique is set to Volumetric, where no heating will be performed and headspace gas will not be collected. If set to Auto, a sample of the corresponding input sample will be heated from MinRampTemperature to MaxRampTemperature according to the TemperatureRampRate in order to determine the temperature at which all water is released. This temperature will then be used for the resulting experiment.
Default Calculation: If Technique is set to Volumetric, automatically set to Ambient. If Technique is set to Coulometric, automatically set to Auto.
MinRampTemperature
When Temperature is set to Auto, indicates the starting temperature of the temperature ramping to determine the temperature at which the sample's water is released.
Pattern Description: Greater than or equal to 50 degrees Celsius and less than or equal to 250 degrees Celsius or Null.
MaxRampTemperature
When Temperature is set to Auto, indicates the ending temperature of the temperature ramping to determine the temperature at which the sample's water is released.
Pattern Description: Greater than or equal to 50 degrees Celsius and less than or equal to 250 degrees Celsius or Null.
TemperatureRampRate
When Temperature is set to Auto, indicates the rate at which the samples are heated to determine temperature at which the sample's water is released.
Pattern Description: Greater than or equal to 1 degree Celsius per minute and less than or equal to 15 degrees Celsius per minute or Null.
GasFlowRate
Indicates the rate at which nitrogen is flowed to carry the headspace gas from the sample into the Karl Fischer reagent.
Default Calculation: Automatically set to 10 Millililter / Minute if SamplingMethod is set to Headspace.
Pattern Description: Greater than or equal to 10 milliliters per minute and less than or equal to 150 milliliters per minute or Null.
Titration
Medium
Indicates the solvent in which the sample will be dissolved for the Karl Fischer reaction to occur. Sample will be dissolved in this solvent and then either treated with the KarlFischerReagent directly, or the sample will be heated and the headspace gas will be titrated with KarlFischerReagent.
Default Calculation: If Technique is set to Volumetric, automatically set to Model[Sample, "HYDRANAL Methanol Rapid"], which is as mixture of anhydrous methanol, sulfur dioxide, and imidazole; these additives enable faster determination of water content. Model[Sample, "HYDRANAL Methanol Dry"] (anhydrous methanol without the additives) may also be used.
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or MethanolDry or MethanolRapid or Null.
Programmatic Pattern: ((KarlFischerTitrationMediumP | (ObjectP[{Model[Sample], Object[Sample]}] | _String)) | Automatic) | Null
MediumVolume
Indicates the amount of Medium to be added to the reaction chamber if Technique is set to Volumetric. Note that this value can only be set to one of the Graduations of the ReactionVessel of a given instrument.
Pattern Description: Greater than or equal to 25 milliliters and less than or equal to 75 milliliters in increments of 25 milliliters or Null.
Standards & Blanks
Standard
Indicates the sample used to validate the instrument as a whole by measuring the Karl Fischer reagent's rate of reaction, and water content drift. Liquid water may be used directly for this, or a a certified water content standard may be used. If a standard different from these is selected, the expected water content is determined from the sample's WaterContent field. If WaterContent is not populated, water content is determined from the sample's Composition.
Default Calculation: If Method is set to Volumetric, automatically set to Model[Sample, "Milli-Q water"]. If Method is set to Coulometric and Temperature is set to above 200 Celsius, automatically set to Model[Sample,"HYDRANAL Water Standard KF-Oven 220C-230C"]. Otherwise, automatically set to Model[Sample, "HYDRANAL - Water Standard KF-Oven 150-160 C"].
Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample.
StandardAmount
Indicates the amount of standard to be added to the reaction chamber or headspace vial for its water content to be measured.
Default Calculation: If Standard is set to Model[Sample, "Milli-Q water"], automatically set to 10 Microliter. If Standard is a non-water liquid, automatically set to 1.5 Milliliter. If Standard is a solid, automatically set to 50 Milligram. .
Programmatic Pattern: (RangeP[1*Milligram, 5*Gram] | RangeP[1*Microliter, 5*Milliliter]) | Automatic
NumberOfStandards
Indicates the number of Standard samples whose water content is measured to validate the titration instrument.
NumberOfBlanks
Indicates the number of empty vials whose water content is measured to accurately capture the humidity of the surroundings. This option is only valid if SamplingMethod is set to Headspace.
Pattern Description: Greater than or equal to 1 and less than or equal to 5 in increments of 1 or Null.
Grinding
Grind
Determines if the sample is ground to a fine powder (to reduce the size of powder particles) via a lab mill (grinder) before measuring the water content.
Default Calculation: Automatically set to True if the provided sample is a solid tablet or capsule. Otherwise, set to False.
GrinderType
Type of grinder that is used for reducing the size of the powder particles (grinding the sample into a fine powder) before packing the sample into a melting point capillary and measuring the melting temperature. Options include BallMill, KnifeMill, and automated MortarGrinder. BallMill consists of a rotating or vibrating grinding container with sample and hard balls inside in which the size reduction occurs through impact/friction of hard balls on/with the solid particles. KnifeMill consists of rotating sharp blades in which size reduction occurs through cutting of the solid particles into smaller pieces. Automated MortarGrinder consists of a rotating bowl (mortar) with the sample inside and an angled revolving column (pestle) in which size reduction occurs through pressure and friction between mortar, pestle, and sample particles.
Default Calculation: Automatically set to the GrinderType of the specified Grinder. If Grinder is not specified but Grind is True, automatically set to KnifeMill.
GrindAmount
Default Calculation: If Grind is True and the input is Tablet and the Amount option is less than three times the input sample's SolidUnitWeight, automatically set to 4. Otherwise, automatically set to 4 + the Amount divided by the input sample's SolildUnitWeight (rounded down).
Pattern Description: Greater than or equal to 1 and less than or equal to 100 in increments of 1 or Null.
Grinder
Pattern Description: An object of type or subtype Model[Instrument, Grinder] or Object[Instrument, Grinder] or Null.
Programmatic Pattern: (ObjectP[{Model[Instrument, Grinder], Object[Instrument, Grinder]}] | Automatic) | Null
Fineness
The approximate size of the largest particle in a solid sample. Fineness, Amount, and BulkDensity are used to determine a suitable Grinder using PreferredGrinder function if Grind is set to True and Grinder is not specified.
Pattern Description: Greater than or equal to 1 micrometer and less than or equal to 80 millimeters in increments of 1 micrometer or Null.
BulkDensity
The mass of a volume unit of the powder. The volume for calculating BulkDensity includes the volumes of particles, internal pores, and inter-particle void spaces. This parameter is used to calculate the volume of a powder from its mass (Amount). The volume, in turn, is used along with the fineness in PreferredGrinder to determine a suitable Grinder if Grind is set to True and Grinder is not specified.
Pattern Description: Greater than or equal to 1 milligram per milliliter and less than or equal to 25 grams per milliliter in increments of 1 milligram per milliliter or Null.
Programmatic Pattern: (RangeP[1*(Milligram/Milliliter), 25*(Gram/Milliliter), 1*(Milligram/Milliliter)] | Automatic) | Null
GrindingContainer
The container that the sample is transferred into for the grinding process if Grind is set to True. Refer to instrumentation table in help files for more information about the containers that are used for each model of grinders.
Default Calculation: Automatically set to a suitable container based on the selected grinder Instrument and Amount of the sample.
Pattern Description: An object of type or subtype Model[Container, Vessel], Object[Container, Vessel], Model[Container, GrindingContainer], or Object[Container, GrindingContainer] or a prepared sample or Null.
Programmatic Pattern: ((ObjectP[{Model[Container, Vessel], Object[Container, Vessel], Model[Container, GrindingContainer], Object[Container, GrindingContainer]}] | _String) | Automatic) | Null
GrindingBead
In ball mills, grinding beads or grinding balls are used along with the sample inside the grinding container to beat and crush the sample into fine particles as a result rapid mechanical movements of the grinding container.
Default Calculation: Automatically set 2.8 mm stainless steel if Grind is set to True and GrinderType is set to BallMill.
Pattern Description: An object of type or subtype Model[Item, GrindingBead] or Object[Item, GrindingBead] or Null.
Programmatic Pattern: (ObjectP[{Model[Item, GrindingBead], Object[Item, GrindingBead]}] | Automatic) | Null
NumberOfGrindingBeads
In ball mills, determines how many grinding beads or grinding balls are used along with the sample inside the grinding container to beat and crush the sample into fine particles.
Default Calculation: Automatically set to a number of grinding beads that roughly have the same volume as the sample if Grind is set to True and GrinderType is set to BallMill. The number is estimated based on the estimated volume of the sample and diameter of the selected GrindingBead, considering 50% of packing void volume. When calculated automatically, NumberOfGrindingBeads will not be less than 1 or greater than 20.
Pattern Description: Greater than or equal to 1 and less than or equal to 20 in increments of 1 or Null.
GrindingRate
Indicates the speed of the circular motion exerted by grinders to pulverize the samples into smaller powder particles.
Default Calculation: Automatically set to the default RPM for the selected Grinder according to the values in Table x.x, if Grind is set to True.
Pattern Description: Greater than or equal to 0.01 hertz and less than or equal to 420 hertz or greater than or equal to 1 revolution per minute and less than or equal to 25000 revolutions per minute or Null.
Programmatic Pattern: ((RangeP[1*RPM, 25000*RPM] | RangeP[0.01*Hertz, 420*Hertz]) | Automatic) | Null
GrindingTime
Default Calculation: Automatically set to a default value based on the selected Grinder according to table x.x if Grind is set to True.
Pattern Description: Greater than or equal to 1 second and less than or equal to 72 hours in increments of 1 second or Null.
NumberOfGrindingSteps
Determines how many times the grinding process is repeated to completely grind the sample and prevent excessive heating of the sample. Between each grinding step there is a cooling time that the grinder is switched off to cool down the sample and prevent excessive rise in sample's temperature.
Pattern Description: Greater than or equal to 1 and less than or equal to 50 in increments of 1 or Null.
CoolingTime
Determines the duration of time between each grinding step that the grinder is switched off to cool down the sample and prevent excessive rise in the sample's temperature.
Default Calculation: Automatically set to 30 Second if Grind is set to True and NumberOfGrindingSteps is greater than 1.
Pattern Description: Greater than or equal to 1 second and less than or equal to 72 hours in increments of 1 second or Null.
GrindingProfile
A set of steps of the grinding process, with each step provided as {grinding rate, grinding time} or as {wait time} indicating a cooling period to prevent the sample from overheating.
Default Calculation: Automatically set to reflect the selections of GrindingRate, GrindingTime, NumberOfGrindingSteps, and CoolingTime if Grind is set to True.
Programmatic Pattern: ({({RangeP[0*RPM, 25000*RPM] | RangeP[0*Hertz, 420*Hertz], RangeP[1*Second, $MaxExperimentTime, 1*Second]} | {RangeP[1*Second, $MaxExperimentTime, 1*Second]})..} | Automatic) | 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} 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} 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 (13)
InstrumentTechniqueMismatch (1)
KarlFischerReagentComponents (1)
MediumVolumeMismatch (1)
MinRampTemperatureNotBelowMax (1)
SampleAmountStateConflict (1)
SamplingMethodMismatch (2)
StandardAmountMismatch (1)
TechniqueSamplingMethodMismatch (1)
Last modified on Wed 13 Aug 2025 23:03:20