ecl-logo Documentation
ECL`

ExperimentMeasureCount

ExperimentMeasureCount[Objects]⟹Protocol

creates a MeasureCount Protocol which determines the count of Objects.

    
In count measurements, the number of tablets in a given tablet sample is calculated by determining the average weight of the tablets in the sample and the total mass of the given tablet sample.
    

Experimental Principles

    Figure 1.1: Procedural overview of a count measurement. Step 1: The average tablet weight is calculated by weighing multiple individual tablets and stored in the sample model's SolidUnitWeight field. This step is skipped if SolidUnitWeight is already known. Step 2: The entire sample weight is measured on a scale. This step can be skipped if the total weight is alrady known. Step 3: The number of tablets is calculated by dividing the mass of the sample minus the mass of the container by the average tablet weight.

Instrumentation

    Ohaus Pioneer PA124

    Figure 2.1: Items are transferred through an ionizer, which floods the local environment with positive and negative ions. This removes any static electricity that has built up on items and provides a more stable and accurate mass reading.

Experiment Options

    General

    ParameterizeSolidUnits

    For each input, indicates if a small number of tablets or sachets should be weighed to determine the average solid unit weight of this sample. If specified when SolidUnitWeight is already informed, the newly recorded weight of the tablets or sachets will overwrite the existing SolidUnitWeight.
    Default Value: Automatic
    Default Calculation: Automatic will resolve to True if SolidUnitWeight is unknown and/or SolidUnitParameterizationReplicates is specified, or False if SolidUnitWeight is already informed.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: experiment samples

    SolidUnitParameterizationReplicates

    For each input, the number of tablets or sachets that should be weighed to determine the average solid unit weight of this sample. Cannot be specified if ParameterizeSolidUnits is set to False. If specified when SolidUnitWeight is already informed, the newly recorded weight of the tablets or sachets will overwrite the existing SolidUnitWeight.
    Default Value: Automatic
    Default Calculation: If the SolidUnitWeight is unknown or ParameterizeSolidUnits is set to True, automatically resolves to 10, if enough are available. If SolidUnitWeight is already informed and/or ParameterizeSolidUnits is set to False, resolves to Null.
    Pattern Description: Greater than or equal to 5 and less than or equal to 20 in increments of 1 or Null.
    Programmatic Pattern: (RangeP[5, 20, 1] | Automatic) | Null
    Index Matches to: experiment samples

    MeasureTotalWeight

    For each input, indicates if the total weight of this sample should be measured. If specified when Mass (in Object[Sample]) is already informed, the newly recorded total weight of the sample will overwrite the existing Mass.
    Default Value: Automatic
    Default Calculation: Automatic will resolve to True if Mass (in Object[Sample]) is unknown or False if Mass is already informed.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: experiment samples

    NumberOfReplicates

    The number of times to repeat the experiment on each provided sample. Note that if specified, the recorded measurements will be pooled for determining the count of the sample(s): the SolidUnitWeight and the Mass in Object[Sample] (if determined in this experiment) will be calculated from the average of all experimental replicates and the count of the sample is calculated from the average SolidUnitWeight and the average Mass.
    Default Value: Null
    Pattern Description: Greater than or equal to 2 in increments of 1 or Null.
    Programmatic Pattern: GreaterEqualP[2, 1] | Null

    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 1.
    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

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

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

    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

    Tablet Parameterization

    Measure the average weight of an individual tablet prior to calculating the tablet count:

    Total Weight Measurement

    Measure the total weight of the sample prior to calculating the tablet count even if it is known:

Warnings and Errors

    Messages  (18)

    DiscardedSamples  (1)

    If the given samples are discarded, they cannot be counted:

    EmptyContainers  (1)

    Prints a message and returns $Failed if given any empty containers:

    IncompatibleContainer  (2)

    If MeasureTotalWeight is set to True, the sample needs to be in a container that is compatible with ExperimentMeasureWeight (MeasureWeightContainerP) even if the Mass is known:

    If the sample needs to be weight measured, it needs to be in a container that is compatible with ExperimentMeasureWeight (MeasureWeightContainerP):

    InputContainsTemporalLinks  (1)

    A Warning is thrown if any inputs or options contain temporal links:

    InvalidParameterizationOptions  (1)

    If the option SolidUnitParameterizationReplicates is specified, ParameterizeSolidUnits cannot be False:

    MassKnown  (1)

    Throws a warning if the option MeasureTotalWeight is set to True, although Mass is known:

    NonTabletOrSachetSamples  (1)

    If the given samples are not tablets or sachets, a warning is thrown:

    ObjectDoesNotExist  (4)

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

    ParameterizationReplicatesRequired  (2)

    If the option ParameterizeSolidUnits is Automatic, but SolidUnitWeight is unknown, SolidUnitParameterizationReplicates cannot be Null:

    If the option ParameterizeSolidUnits is set to True, SolidUnitParameterizationReplicates cannot be Null:

    ParameterizationRequired  (1)

    If the option ParameterizeSolidUnits is set to False, SolidUnitWeight has to be known:

    SolidUnitWeightKnown  (2)

    Throws a warning if the option ParameterizeSolidUnits is set to True, although SolidUnitWeight is known:

    Throws a warning if the option SolidUnitParameterizationReplicates is specified, although SolidUnitWeight is known:

    TotalWeightRequired  (1)

    If the option MeasureTotalWeight is set to False, Mass has to be known:

Last modified on Wed 27 Aug 2025 17:02:36

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