ts_ids_components.particle_sizer.run module#
Run component for particle sizer IDSs.
ParticleSizerRun extends the generic
Run component with a vendor record
identifier, a free-text comment, and a standardized start/stop/acquired
timestamp (reusing Time, whose
start/stop/acquired fields already cover the timestamps particle
sizer instruments report for a run).
ParticleSizerRun carries a pk
(UUIDPrimaryKey) so a
consuming IDS can declare it as a top-level array (runs: List[ParticleSizerRun])
and methods/results/datacubes can reference the specific run that produced
them via fk_run, rather than relying on a file-wide singleton. pk
values must be generated deterministically by the task script (seeded from
file content and task script identity), not by this component.
- Model ParticleSizerRun[source]#
Bases:
RunA single particle sizer measurement run or sequence.
Show JSON schema
{ "description": "A single particle sizer measurement run or sequence.", "type": "object", "properties": { "id": { "description": "Unique identifier assigned to a specific run (execution) of an experiment.", "type": [ "string", "null" ] }, "name": { "description": "Name assigned to a specific run (execution) of an experiment.", "type": [ "string", "null" ] }, "logs": { "description": "Log messages recorded during a specific run (execution) of an experiment.", "items": { "type": "string" }, "type": "array" }, "pk": { "@primary_key": true, "description": "Primary key for this run, referenced by methods/results/datacubes belonging to it.", "type": "string" }, "record_id": { "description": "Vendor-assigned record identifier for this run, as stored in the raw file. Distinct from the generic ``id`` field, which is a user-facing run identifier.", "type": [ "string", "null" ] }, "comment": { "description": "Free-text comment or note recorded for this run.", "type": [ "string", "null" ] }, "time": { "$ref": "#/definitions/Time", "description": "Timestamps for the run: ``start`` and ``stop`` bound the measurement, and ``acquired`` records when the data was captured/exported." } }, "additionalProperties": false, "required": [ "pk" ], "definitions": { "RawTime": { "additionalProperties": false, "description": "The base model for capturing common time fields found in primary data.", "properties": { "start": { "description": "Process/experiment/task start time.", "type": [ "string", "null" ] }, "created": { "description": "Data created time.", "type": [ "string", "null" ] }, "stop": { "description": "Process/experiment/task stop/finish time.", "type": [ "string", "null" ] }, "duration": { "description": "Process/experiment/task duration.", "type": [ "string", "null" ] }, "last_updated": { "description": "Data last updated time of a file/method.", "type": [ "string", "null" ] }, "acquired": { "description": "Data acquired/exported/captured time.", "type": [ "string", "null" ] }, "modified": { "description": "Data last modified/edited time.", "type": [ "string", "null" ] }, "lookup": { "description": "Data lookup time.", "type": [ "string", "null" ] } }, "type": "object" }, "Time": { "additionalProperties": false, "description": "A model for datetime values converted to a standard ISO format and their\nrespective raw datetime values in the primary data.", "properties": { "start": { "description": "Process/experiment/task start time.", "type": [ "string", "null" ] }, "created": { "description": "Data created time.", "type": [ "string", "null" ] }, "stop": { "description": "Process/experiment/task stop/finish time.", "type": [ "string", "null" ] }, "duration": { "description": "Process/experiment/task duration.", "type": [ "string", "null" ] }, "last_updated": { "description": "Data last updated time of a file/method.", "type": [ "string", "null" ] }, "acquired": { "description": "Data acquired/exported/captured time.", "type": [ "string", "null" ] }, "modified": { "description": "Data last modified/edited time.", "type": [ "string", "null" ] }, "lookup": { "description": "Data lookup time.", "type": [ "string", "null" ] }, "raw": { "$ref": "#/definitions/RawTime", "description": "Raw time values from primary data." } }, "type": "object" } } }
- Validators:
- field id_: Nullable[str] (alias 'id')#
Unique identifier assigned to a specific run (execution) of an experiment.
- field pk: str#
Primary key for this run, referenced by methods/results/datacubes belonging to it.
- Constraints:
func = <function validate_uuid at 0x7f1493ac61f0>
json_schema_input_type = PydanticUndefined