ecl-logo Documentation

Object[UnitOperation]

A detailed set of parameters that specifies a single step in a larger protocol in the laboratory.

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[UnitOperation, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[UnitOperation]
    Pattern Description: Object[UnitOperation]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

General

Experimental Results

    EnvironmentalData

    Measurements of environmental conditions (temperature and humidity) recorded during the execution of this unit operation.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[Data]

    Data

    Any primary data generated by this unit operation.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[Data]

Preparatory Incubation

    Incubate

    Indicates if the SamplesIn should be incubated at a fixed temperature prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    Thaw

    Indicates if any frozen SamplesIn should be incubated until visibly liquid prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    IncubationTemperatureReal

    Temperature at which the SamplesIn should be incubated for the duration of the IncubationTime prior to starting the experiment.
    Format: Multiple
    Class: Real
    Programmatic Pattern: GreaterEqualP[0 Kelvin]

    IncubationTemperature Expression

    Temperature at which the SamplesIn should be incubated for the duration of the IncubationTime prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[Ambient | Null | GreaterEqualP[0 Kelvin]]

    IncubationTime

    Duration for which SamplesIn should be incubated at the IncubationTemperature prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Second] | 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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Second] | Null]

    Mix

    Indicates if this sample should be mixed while incubated, prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    MixType

    Indicates the style of motion used to mix the sample, prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[MixTypeP | 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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Second] | Null]

    IncubationInstrument

    The instrument used to perform the Mix and/or Incubation, prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[ObjectP[{Model[Instrument], Object[Instrument]}] | Null]

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[{_Integer | Null, ObjectP[Model[Container]] | Null} | Null]

    IncubateAliquotDestination Well

    The desired position in the corresponding IncubateAliquotContainer in which the aliquot samples will be placed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]

    IncubateAliquotReal

    The amount of each sample that should be transferred from the SamplesIn into the IncubateAliquotContainer when performing an aliquot before incubation.
    Format: Multiple
    Class: Real
    Unit: 1 liter
    Programmatic Pattern: GreaterEqualP[0 Liter]

    IncubateAliquotExpression

    The amount of each sample that should be transferred from the SamplesIn into the IncubateAliquotContainer when performing an aliquot before incubation.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[All | Null | GreaterEqualP[0 Liter]]

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).
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    CentrifugeInstrument

    The centrifuge that will be used to spin the provided samples prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[ObjectP[{Model[Instrument], Object[Instrument]}] | Null]

    CentrifugeIntensity

    The rotational speed or the force that will be applied to the samples by centrifugation prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterP[0 RPM] | GreaterP[0 GravitationalAcceleration] | Null]

    CentrifugeTime

    The amount of time for which the SamplesIn should be centrifuged prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Second] | Null]

    CentrifugeTemperatureReal

    The temperature at which the centrifuge chamber should be held while the samples are being centrifuged prior to starting the experiment.
    Format: Multiple
    Class: Real
    Programmatic Pattern: GreaterEqualP[0 Kelvin]

    CentrifugeTemperature Expression

    The temperature at which the centrifuge chamber should be held while the samples are being centrifuged prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[Ambient | Null | GreaterEqualP[0 Kelvin]]
    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.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    CentrifugeAliquotContainer Expression

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[{_Integer | _String, ObjectP[{Model[Container], Object[Container]}]} | Null | ObjectP[{Model[Container], Object[Container]}]]

    CentrifugeAliquotDestination Well

    The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]

    CentrifugeAliquotReal

    The amount of a sample that should be transferred from the input samples into aliquots.
    Format: Multiple
    Class: Real
    Programmatic Pattern: GreaterEqualP[0 Milliliter]

    CentrifugeAliquotExpression

    The amount of a sample that should be transferred from the input samples into aliquots.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[All | Null | GreaterEqualP[0 Milliliter]]

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).
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

    FiltrationType

    The type of filtration method that should be used to perform the filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[FiltrationTypeP | Null]

    FilterInstrument

    The instrument that should be used to perform the filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[ObjectP[{Model[Instrument], Object[Instrument]}] | Null]
    The filter that should be used to remove impurities from the samples.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    FilterString

    The filter that should be used to remove impurities from the samples.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    FilterExpression

    The filter that should be used to remove impurities from the samples.
    Format: Multiple
    Class: Expression

    FilterMaterial

    The membrane material of the filter that should be used to remove impurities from the SamplesIn prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[FilterMembraneMaterialP | 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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[FilterMembraneMaterialP | Null]

    FilterPoreSize

    The pore size of the filter that should be used when removing impurities from the SamplesIn prior to starting the experiment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[FilterSizeP | Null]

    PrefilterPoreSize

    The pore size of the filter; all particles larger than this should be removed during the filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[FilterSizeP | Null]

    FilterSyringe

    The syringe used to force that sample through a filter.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[ObjectP[{Model[Container], Object[Container]}] | Null]
    The filter housing that should be used to hold the filter membrane when filtration is performed using a standalone filter membrane.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    FilterHousingExpression

    The filter housing that should be used to hold the filter membrane when filtration is performed using a standalone filter membrane.
    Format: Multiple
    Class: Expression

    FilterIntensity

    The rotational speed or force at which the samples will be centrifuged during filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterP[0 RPM] | GreaterP[0 GravitationalAcceleration] | Null]

    FilterTime

    The amount of time for which the samples will be centrifuged during filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Minute] | Null]

    FilterTemperature

    The temperature at which the centrifuge chamber will be held while the samples are being centrifuged during filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Celsius] | Null]
    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.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    FilterContainerOutString

    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.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    FilterContainerOutExpression

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[{_Integer | _String, ObjectP[{Model[Container], Object[Container]}]} | Null | ObjectP[{Model[Container], Object[Container]}]]

    FilterAliquotDestinationWell

    The desired position in the corresponding AliquotContainer in which the aliquot samples will be placed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]
    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.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    FilterAliquotContainerString

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]

    FilterAliquotContainer Expression

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[{_Integer | _String, ObjectP[{Model[Container], Object[Container]}]} | Null | ObjectP[{Model[Container], Object[Container]}]]

    FilterAliquotReal

    The amount of each sample that should be transferred from the SamplesIn into the FilterAliquotContainer when performing an aliquot before filtration.
    Format: Multiple
    Class: Real
    Unit: 1 millimeter
    Programmatic Pattern: GreaterP[0 Milli Meter]

    FilterAliquotExpression

    The amount of each sample that should be transferred from the SamplesIn into the FilterAliquotContainer when performing an aliquot before filtration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[All | Null | GreaterP[0 Milli Meter]]

    FilterSterile

    Indicates if the filtration of the samples should be done in a sterile environment.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[BooleanP | Null]

Aliquoting

    TargetConcentration

    The desired final concentration of analyte in the aliquot samples after dilution of aliquots of the input samples with the ConcentratedBuffer and BufferDiluent (or AssayBuffer).
    Format: Multiple
    Class: Expression
    Programmatic Pattern: Gram Gram Hold[GreaterEqualP[0 Micromolar] | GreaterEqualP[0 -----] | {(GreaterP[0 Molar] | GreaterP[0 -----] | Null)..}] Liter Liter

    TargetConcentrationAnalyte

    For each member of TargetConcentration, the substance whose final concentration is attained with TargetConcentration.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ObjectP[IdentityModelTypes] | {(ObjectP[IdentityModelTypes] | Null)..}
    The concentrated buffer source which is added to each of the AliquotSamples to obtain 1x buffer concentration after dilution of the AliquotSamples which are used in lieu of the SamplesIn for the manual unit operation.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    ConcentratedBufferString

    The concentrated buffer which should be diluted by the BufferDilutionFactor in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent).
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    ConcentratedBufferExpression

    The concentrated buffer which should be diluted by the BufferDilutionFactor in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent).
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null | ObjectP[{Object[Sample], Model[Sample]}]]

    BufferDilutionFactor

    The dilution factor by which the concentrated buffer is diluted in preparing the AliquotSamples to obtain a 1x buffer concentration after dilution of the AliquotSamples which are used in lieu of the SamplesIn for the manual unit operation.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterP[0] | Null]
    The diluent used to dilute the concentration of the concentrated buffer in preparing the AliquotSamples which are used in lieu of the SamplesIn for the manual unit operation.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    BufferDiluentString

    The buffer used to dilute the aliquot sample such that ConcentratedBuffer is diluted by BufferDilutionFactor in the final solution.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    BufferDiluentExpression

    The buffer used to dilute the aliquot sample such that ConcentratedBuffer is diluted by BufferDilutionFactor in the final solution.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | ObjectP[{Object[Sample], Model[Sample]}] | Null]
    The desired buffer for the AliquotSamples which are used in lieu of the SamplesIn for the manual unit operation.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    AssayBufferString

    The buffer sample used to dilute the final sample in ContainerOut.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    AssayBufferExpression

    The buffer sample used to dilute the final sample in ContainerOut.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | ObjectP[{Object[Sample], Model[Sample]}] | Null]

    DestinationWell

    For each member of DestinationLink, the desired position in the corresponding destination in which the transferred samples will be placed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]
    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.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    AliquotContainerString

    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.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    AliquotContainerExpression

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[{_Integer | _String, ObjectP[{Model[Container], Object[Container]}]} | _String | Null | ObjectP[{Model[Container], Object[Container]}]]

    AliquotPreparation

    Indicates if the aliquotting should occur manually or on a robotic liquid handler.
    Format: Single
    Class: Expression
    Programmatic Pattern: ListableP[PreparationMethodP | Null]

    ConsolidateAliquots

    Indicates if identical aliquots should be consolidated in a single sample.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    AssayVolume

    The desired total volume of the aliquoted sample plus dilution buffer.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[GreaterEqualP[0 Milliliter] | Null]

    AliquotSampleLabel

    The label of the samples, after they are aliquotted.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[_String | Null]

Sample Post-Processing

    AliquotSampleStorageCondition

    Indicates the conditions under which the aliquoted samples are stored after the unit operation is completed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[SampleStorageTypeP | Disposal | Null]

    SamplesInStorageCondition

    Indicates the conditions under which the source samples are stored after the unit operation is completed.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[SampleStorageTypeP | Disposal | Null]

    MeasureWeight

    Indicates if the weight of the solid samples modified in the course of the experiment are measured after running the experiment.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    MeasureVolume

    Indicates if the volume of the liquid samples modified in the course of the experiment are measured after running the experiment.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    ImageSample

    Indicates if the samples that are modified in the course of the experiment are imaged after running the experiment.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    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.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: ListableP[SampleStorageTypeP | Disposal | Null]
Last modified on Mon 26 Sep 2022 15:43:53