ecl-logo Documentation
ECL`

ExperimentMeasureRefractiveIndex

ExperimentMeasureRefractiveIndex[Samples]⟹Protocol

generate a Protocol object for measuring the refractive index of input 'sampleIn' at defined temperature.

    
Refractive index (RI) measurement is used to identify an unknown liquid compound or quantify the purity of a liquid substance by comparing it to literature values. The refractometer uses light source, prism and a Charge-coupled Device (CCD) to identify the critical angle where total reflection occurs at the prism-sample interface. Once the critical angle is obtained, RI can be calculated using Snell's law (n1 = n2 * Sin[C] where n1 = refractive index of sample, n2 = refractive index of prism, C = critical angle). RI measurement highly depends on wavelength and temperature. The refractometer uses fixed wavelength 589 nm (a characteristic spectral absorption line of sodium) to eliminate wavelength dependency of the RI measurement. The refractometer uses Peltier temperature control to stabilize the temperature of both the sample and the measuring prism precisely. Applications include the investigation of pharmaceuticals, the evaluation of scents, and the quality monitoring of chemicals, beverage, and pharmaceuticals.
    

Experimental Principles

    Figure 1.1: Procedural overview of a MeasureRefractiveIndex experiment. Step 1: The flow cell is cleaned by the PrimaryWashSolution (default is water), followed by the SecondaryWashSolution (default is ethanol) and the TertiaryWashSolution (default is acetone). Each washing solution (120 μL) can be soaked in flow cell for WashSoakTime (default is 0 second) and then WashingVolume (default is 2mL) of each solution is sequentially flushed through the flow cell by the NumberOfWashes (default is 2), followed by forced-air drying of the flow cell for DryTime (default is 5 Minutes). Step 2: The internal water check is performed by measuring the refractive index of Milli-Q water. If the measured value is out of the acceptance range (1.332987 +/- 0.000100), internal water adjustment is performed by modifying the offset of the internal calibration curve. Step 3: The same washing and forced-air drying procedures as Step 1 are performed. Step 4 (Optional): CalibrationVolume (default is 120 μL) of Calibrant (default is Milli-Q water) is used to measure the refractive index of Calibrant at CalibrationTemperature (default is 20 Celsius), followed by washing and forced-air drying the flow cell. Step 5: The SampleVolume (default is 120 μL) of each sample is injected into the flow cell at SampleFlowRate (default is 24 μL/second) and EquilibrationTime (default is 10 seconds with TemperatureScan mode, otherwise 1 second) is applied to allow sample to stabilize temperature. The refractive index of each sample is performed based on RefractiveIndexReadingMode (default is FixedMeasurement) at Temperature (default is 20 Celsius). Each measurement is set to MeasurementAccuracy (default is 0.00001). Step 6: The washing and forced-air drying the flow cell. Step 7 (Optional): The refractive index of Calibrant is measured after each sample measurement.

Instrumentation

    Abbemat 650 Refractometer

    Figure 2.1: The refractometer instrument mainly consists of a micro flow cell, lens, filter, prism, light source, Charged-Couple Device (CCD) and Peltier temperature controller. Once the liquid sample is loaded into the micro flow cell, temperature controller stabilizes the temperature of both the sample and the measuring prism precisely. The LED light source is filtered by the filter having fixed wavelength of 589 nm and the filtered light is guided to the prism-sample interface. The critical angle where total reflection occurs can be calculated by finding the parameters of the graph from the light intensity curve obtained by CCD. The refractive index of the sample can be calculated by using Snell's law (Ns = Np * Sin[c] where Ns = the refractive index of sample, Np = the refractive index of prism, c = the critical angle.)

Experiment Options

    General

    Refractometer

    The refractometer that is used to measure the refractive index of the sample.
    Default Value: Object[Instrument, Refractometer, Double Rainbow]
    Pattern Description: An object of type or subtype Model[Instrument, Refractometer] or Object[Instrument, Refractometer]
    Programmatic Pattern: ObjectP[{Model[Instrument, Refractometer], Object[Instrument, Refractometer]}]

    Preparation

    The method by which the primitive should be executed in the laboratory. Manual primitives are executed by a laboratory operator and Robotic primitives are executed by a liquid handling work cell.
    Default Value: Manual
    Pattern Description: Manual or Robotic.
    Programmatic Pattern: PreparationMethodP

    Sample Injection

    NumberOfReplicates

    The number of times sample volume will be injected into the refractometer and measured.
    Default Value: Null
    Pattern Description: Greater than or equal to 1 and less than or equal to 5 in increments of 1 or Null.
    Programmatic Pattern: RangeP[1, 5, 1] | Null

    SampleVolume

    The amount of sample volume injected into the flow cell in order to measure the refractive index. The minimum required volume to fill U-shaped micro flow cell unit for the refractometer is 100 Microliters. If the sample volume is more than 200 Microliters, excess sample volume will be flushed to waste.
    Default Value: 120 microliters
    Pattern Description: Greater than or equal to 100 microliters and less than or equal to 200 microliters.
    Programmatic Pattern: RangeP[100*Microliter, 200*Microliter]
    Index Matches to: experiment samples

    SampleFlowRate

    The rate at which the sample is drawn from the vial and injected into the refractometer. With high viscosity samples a slower SampleFlowRate is recommended (10% of SampleVolume/second).
    Default Value: Automatic
    Default Calculation: Automatically set to 20% SampleVolume / second.
    Pattern Description: Greater than or equal to 1 microliter per second and less than or equal to 1000 microliters per second.
    Programmatic Pattern: RangeP[1*(Microliter/Second), 1000*(Microliter/Second)] | Automatic
    Index Matches to: experiment samples

    Measurement

    NumberOfReads

    The number of consecutive measurements (up to 10) taken of each sample after the sample is injected into the instrument. This only works with FixedMeasurement mode.
    Default Value: 1
    Pattern Description: Greater than or equal to 1 and less than or equal to 10 in increments of 1.
    Programmatic Pattern: RangeP[1, 10, 1]

    RefractiveIndexReadingMode

    The refractometer can perform different measurement modes. FixedMeasurement mode measures the sample at fixed temperature. TemperatureScan mode measures samples over a temperature range with fixed intervals. TimeScan mode performs multiple measurements over a period of time by taking repeated measurement over a fixed time interval.
    Default Value: FixedMeasurement
    Pattern Description: FixedMeasurement, TemperatureScan, or TimeScan.
    Programmatic Pattern: RefractiveIndexReadingModeP
    Index Matches to: experiment samples

    Temperature

    The temperature at which the flow cell will be incubated for the course of refractive index measurement.
    Default Value: Automatic
    Default Calculation: If RefractiveIndexReadingMode is set to FixedMeasurement or TimeScan, default temperature is set to 20.00 Celsius. If RefractiveIndexReadingMode is set to TemperatureScan, default temperature is set to Span[20 Celsius ,50 Celsius].
    Pattern Description: A span from anything greater than or equal to 4 degrees Celsius and less than or equal to 125 degrees Celsius to anything greater than or equal to 4 degrees Celsius and less than or equal to 125 degrees Celsius or greater than or equal to 4 degrees Celsius and less than or equal to 125 degrees Celsius.
    Programmatic Pattern: (RangeP[4*Celsius, 125*Celsius] | RangeP[4*Celsius, 125*Celsius] ;; RangeP[4*Celsius, 125*Celsius]) | Automatic
    Index Matches to: experiment samples

    TemperatureStep

    When RefractiveIndexReadingMode is set to TemperatureScan mode, refractive index measurement starts at the initial temperature and is remeasured at each temperature step until final temperature is reached. Temperature interval must be an integer multiple of the TemperatureStep.
    Default Value: Automatic
    Default Calculation: If RefractiveIndexReadingMode is set to TemperatureScan mode, automatically set to (Temperature range)/10 Celsius.
    Pattern Description: Greater than or equal to 1 degree Celsius and less than or equal to 120 degrees Celsius or Null.
    Programmatic Pattern: (RangeP[1*Celsius, 120*Celsius] | Automatic) | Null
    Index Matches to: experiment samples

    TimeDuration

    When RefractiveIndexReadingMode is set to TimeScan mode, the sample is measured every TimeStep until it reaches to the total length of time duration.
    Default Value: Automatic
    Default Calculation: If RefractiveIndexReadingMode is set to TimeScan mode, automatically set to 2 hours.
    Pattern Description: Greater than or equal to 0 hours and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[0*Hour, $MaxExperimentTime] | Automatic) | Null
    Index Matches to: experiment samples

    TimeStep

    When RefractiveIndexReadingMode is set to TimeScan mode, the sample is measured every TimeStep until it reaches to the duration. The measurement will stop when the duration is reached even if it has not reached the next TimeStep.
    Default Value: Automatic
    Default Calculation: If RefractiveIndexReadingMode is set to TimeScan, automatically set to TimeDuration/10 hours.
    Pattern Description: Greater than or equal to 0 seconds and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[0*Second, $MaxExperimentTime] | Automatic) | Null
    Index Matches to: experiment samples

    EquilibrationTime

    The amount of time that the sample is allowed to equilibrate after the temperature reaches to the desired value before recording the refractive index. EquilibrationTime improves the stability of the measurement. With FixedMeasurement mode, the sample will be measured after EquilibrationTime once it reaches the input Temperature. With TemperatureScan mode, the sample will be measured after EquilibrationTime whenever temperature increased by TemperatureStep.
    Default Value: Automatic
    Default Calculation: Automatically set to 10 seconds when RefractiveIndexReadingMode is set to TemperatureScan. Otherwise set to 1 second.
    Pattern Description: Greater than or equal to 0 seconds and less than or equal to 1 hour.
    Programmatic Pattern: RangeP[0*Second, 1*Hour] | Automatic
    Index Matches to: experiment samples

    MeasurementAccuracy

    The target accuracy of the refractive index measurement. Higher accuracy measurement can be achieved by waiting longer for the temperature to stabilize after the EquilibrationTime has passed. At accuracy 0.00001, the instrument requires the temperature to be stable within 0.005 Celsius for 15 seconds before recording the refractive index (if the stability is not reached the instrument must wait longer in order to start recording). At accuracy 0.00002, the instrument requires the temperature to be stable within 0.01 Celsius for 10 seconds before recording the refractive index. At accuracy 0.00006, the instrument requires the temperature to be stable within 0.03 Celsius for 5 seconds before recording the refractive index.
    Default Value: 0.00001
    Pattern Description: 0.00001, 0.00002, or 0.00006.
    Programmatic Pattern: 0.00001 | 0.00002 | 0.00006
    Index Matches to: experiment samples

    Washing

    PrimaryWashSolution

    The first solution used to flush out the flow cell of the instrument before and after each sample. The washing cycle involves the first flushing the flow cell with PrimaryWashSolution, then flushing with the SecondaryWashSolution, and then optionally with the TertiaryWashSolution. After all wash cycle has completed, the flow cell is dried with air for DryTime. If WashSoakTime is provided, each wash solution is allowed to sit in the flow cell for WashSoakTime before being flushed out.
    Default Value: Model[Sample, Milli-Q water]
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample.
    Programmatic Pattern: ObjectP[{Object[Sample], Model[Sample]}] | _String

    SecondaryWashSolution

    A fast-evaporating solution used to flush the primary wash solution out. The washing cycle involves the first flushing the flow cell with PrimaryWashSolution, then flushing with the SecondaryWashSolution, and then optionally with the TertiaryWashSolution. After all wash cycle has completed, the flow cell is dried with air for DryTime. If WashSoakTime is provided, each wash solution is allowed to sit in the flow cell for WashSoakTime before being flushed out.
    Default Value: Model[Sample, Ethanol, Reagent Grade]
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample.
    Programmatic Pattern: ObjectP[{Object[Sample], Model[Sample]}] | _String

    TertiaryWashSolution

    A fast-evaporating solution used to flush the secondary wash solution out. The washing cycle involves the first flushing the flow cell with PrimaryWashSolution, then flushing with the SecondaryWashSolution, and then flushing with the TertiaryWashSolution. After all wash cycle has completed, the flow cell is dried with air for DryTime. If SoakTime is provided, each wash solution is allowed to sit in the flow cell for SoakTime before being flushed out.
    Default Value: Model[Sample, Acetone, Reagent Grade]
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample.
    Programmatic Pattern: ObjectP[{Object[Sample], Model[Sample]}] | _String

    WashingVolume

    The volume of each washing solution injected during each wash cycle into the flow cell to clean sample residue inside of the refractometer.
    Default Value: 2 milliliters
    Pattern Description: Greater than or equal to 2 milliliters and less than or equal to 10 milliliters.
    Programmatic Pattern: RangeP[2*Milliliter, 10*Milliliter]

    WashSoakTime

    The length of time each washing solution is allowed to sit in the flow cell in order to allow any residue to dissolve most effectively.
    Default Value: 0 seconds
    Pattern Description: Greater than or equal to 0 seconds and less than or equal to 15 minutes.
    Programmatic Pattern: RangeP[0*Second, 15*Minute]

    NumberOfWashes

    The number of repeated washing process with each solution. The washing process involves the first flushing the flow cell with PrimaryWashSolution, then flushing with the SecondaryWashSolution, and then flushing with the TertiaryWashSolution. Given NumberOfWashes, each washing solution flushes through the flow cell NumberOfWashes times.
    Default Value: 2
    Pattern Description: Greater than or equal to 1 and less than or equal to 10 in increments of 1.
    Programmatic Pattern: RangeP[1, 10, 1]

    DryTime

    After all wash cycles have been completed, drying process starts. In order to remove any trace of washing solution in the instrument, the instrument flow cell is flushed for the duration of the DryTime.
    Default Value: 5 minutes
    Pattern Description: Greater than or equal to 0 seconds and less than or equal to 10 minutes.
    Programmatic Pattern: RangeP[0*Second, 10*Minute]

    Calibration

    Calibration

    Indicates when the calibration process is performed. The instrument can be calibrated once before any measurement or once between each sample. Calibration process involves measuring the refractive index of Calibrant and comparing it to the known literature value.
    Default Value: None
    Pattern Description: None, BeforeRun, or BetweenSamples.
    Programmatic Pattern: None | BeforeRun | BetweenSamples

    CalibrationTemperature

    The temperature in which the refractive index of Calibrant is measured.
    Default Value: Automatic
    Default Calculation: If Calibration is set to BeforeRun or BetweenSample, CalibrationTemperature is set to 20 Celsius. Otherwise it is set to user specified temperature.
    Pattern Description: Greater than or equal to 10 degrees Celsius and less than or equal to 40 degrees Celsius or Null.
    Programmatic Pattern: (RangeP[10*Celsius, 40*Celsius] | Automatic) | Null

    CalibrantRefractiveIndex

    The known refractive index of the given Calibrant at CalibrationTemperature.
    Default Value: Automatic
    Default Calculation: Set to match the Calibrant model refractive index field.
    Pattern Description: Greater than or equal to 1.26 and less than or equal to 1.72 or Null.
    Programmatic Pattern: (RangeP[1.26, 1.72] | Automatic) | Null

    CalibrantVolume

    The volume of Calibrant is injected into the flow cell before adjusting the calibration function to match the known CalibrantRefractiveIndex.
    Default Value: 120 microliters
    Pattern Description: Greater than or equal to 100 microliters and less than or equal to 200 microliters or Null.
    Programmatic Pattern: RangeP[100*Microliter, 200*Microliter] | Null

    Storage

    CalibrantStorageCondition

    After calibration is completed, any remaining Calibrant which has not been injected is stored under the CalibrantStorageCondition. It is set to disposal by default.
    Default Value: Disposal
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
    Programmatic Pattern: (SampleStorageTypeP | Disposal) | Null

    RecoupSample

    If RecoupSample is True, each sample is flushed back to the original container. Otherwise, the sample is flushed into the waste bottle after measurement has been completed.
    Default Value: False
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP
    Index Matches to: experiment samples

    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.
    Default Value: Automatic
    Default Calculation: Automatically set to 40 Milliliter.
    Pattern Description: All or Count or Count or Mass or Volume or Null.
    Programmatic Pattern: ((Null | (RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All)) | Automatic) | Null
    Index Matches to: experiment samples

    PreparedModelContainer

    Indicates the container in which a Model[Sample] specified as input to the experiment function will be prepared.
    Default Value: Automatic
    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"].
    Pattern Description: An object of type or subtype Model[Container] or Null.
    Programmatic Pattern: ((Null | ObjectP[Model[Container]]) | Automatic) | Null
    Index Matches to: experiment samples

    Post Experiment

    SamplesInStorageCondition

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

    SamplesOutStorageCondition

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

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.
    Default Value: Null
    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 Value: Automatic
    Default Calculation: Resolves to True if any of the corresponding Incubation options are set. Otherwise, resolves to False.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: experiment samples

    IncubationTemperature

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

    IncubationTime

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

    Mix

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

    MixType

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

    MixUntilDissolved

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

    MaxIncubationTime

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

    IncubationInstrument

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

    AnnealingTime

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

    IncubateAliquotContainer

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

    IncubateAliquotDestinationWell

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

    IncubateAliquot

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

    Preparatory Centrifugation

    Centrifuge

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

    CentrifugeInstrument

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

    CentrifugeIntensity

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

    CentrifugeTime

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

    CentrifugeTemperature

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

    CentrifugeAliquotContainer

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

    CentrifugeAliquotDestinationWell

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

    CentrifugeAliquot

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

    Preparatory Filtering

    Filtration

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

    FiltrationType

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

    FilterInstrument

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

    Filter

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

    FilterMaterial

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

    PrefilterMaterial

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

    FilterPoreSize

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

    PrefilterPoreSize

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

    FilterSyringe

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

    FilterHousing

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

    FilterIntensity

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

    FilterTime

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

    FilterTemperature

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

    FilterContainerOut

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

    FilterAliquotDestinationWell

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

    FilterAliquotContainer

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

    FilterAliquot

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

    FilterSterile

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

    Aliquoting

    Aliquot

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

    AliquotAmount

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

    TargetConcentration

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

    TargetConcentrationAnalyte

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

    AssayVolume

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

    ConcentratedBuffer

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

    BufferDilutionFactor

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

    BufferDiluent

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

    AssayBuffer

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

    AliquotSampleStorageCondition

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

    DestinationWell

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

    AliquotContainer

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

    AliquotPreparation

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

    ConsolidateAliquots

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

Protocol Options

    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.
    Default Value: Null
    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.
    Default Value: Null
    Pattern Description: A string or Null.
    Programmatic Pattern: _String | Null

    Post Experiment

    MeasureWeight

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

    MeasureVolume

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

    ImageSample

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

Example Calls

    Measure Refractive Index

    The most basic case is to measure refractive index of the sample at 20 C:
    Measure refractive index of the sample at 30 C with 3 replicates (3 different sampling):
    Measure refractive index of the sample at 30 C with 5 consecutive measurements (single sampling):
    Measure refractive index of the sample at 20 C and measure refractive index of my calibrant at 30 C before sample measurement. In order to measure refractive index of calibrant, its literature value of the refractive index must exit in the database (Model[Sample, myCalibrant][RefractiveIndex]). If it doesn't exist, it can be provided:
    Measure refractive index of the list of samples at 20 C and measure refractive index of calibrant (Milli-Q water) at 20C after each sample:
    Measure refractive index of the list of samples at different temperatures:
    ExperimentMeasureRefractiveIndex with temperature scan mode allows to measure temperature profile of refractive index. By default the temperature range is set to 20 C to 50 C and temperature step is set to 1/10 of the range:
    Temperature scan mode with different temperature range and its step. Temperature interval must be an integer multiple of the temperature step:
    ExperimentMeasureRefractiveIndex with time scan mode allows to measure temporal trajectory of refractive index. By default the time duration is set to 2 hour and time step is set to 1/10 of the duration:
    With time scan mode, time duration and time step can be set to desired values:
    Measure refractive index of the list of samples with different reading modes :
    MeasureRefractiveIndex primitive can be used as part of ExperimentSamplePreparation with sample labels:
    MeasureRefractiveIndex primitive can accept a lit of samples:
    MeasureRefractiveIndex primitive can accept a lit of samples with different reading modes:
    MeasureRefractiveIndex primitive can accept a lit of samples and calibrant:

Preferred Input Containers

    Use a suitable container for the sample amount.

Warnings and Errors

    Messages  (15)

    CalibrantRefractiveIndexDoesntExist  (1)

    If provided calibrant doesn't have refactive index value, it throws an error:

    DiscardedSamples  (1)

    If the provided sample is discarded, an error will be thrown:

    InsufficientSampleVolume  (1)

    If the provided sample doesn't have enough volume, an error will be thrown:

    InvalidRefractiveIndexReadingMode  (1)

    If NumberOfReads is greater than 1 and RefractiveIndexReadingMode is not FixedMeasurement, then an error will be thrown:

    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):

    RefractiveIndexNoVolume  (1)

    If the provided sample's volume is not populated, an error will be thrown:

    SamplesNotInContainers  (1)

    If the provided sample is not in a container, an error will be thrown:

    SolidSamples  (1)

    If the provided sample is solid, an error will be thrown:

    TemperatureStepValueError  (1)

    If the remainder on division of temperature range by temperature step is not zero, an error will be thrown:

    TimeStepValueError  (1)

    If the remainder on division of duration by time step is not zero, an error will be thrown:

Possible Issues

    Very viscous samples

    If ExperimentMeasureRefractiveIndex is called with highly viscous SamplesIn, sample injection, recouping and washing process can be challenging. Make sure that SampleFlowRate to be small (10% of SampleVolume/second).

    Incompatible wash solutions

    In the ExperimentMeasureRefractiveIndex, PrimaryWashSolution, SecondaryWashSolution and TertiaryWashSolution are set as water, ethanol and acetone correspondingly by default. If your sample is not soluble in these solutions, please choose alternatives to ensure your sample is fully removed from the flow cell following measurement and no cross-contamination occurs. The first WashSolution should be a good solvent for your sample, and the SecondaryWashSolution should be a good solvent for the first WashSolution and evaporate quickly (acetone is a good alternative for ethanol).
Last modified on Wed 27 Aug 2025 17:03:04

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