ts_ids_components.particle_sizer.curve module#

Curve file component for particle sizer IDSs.

CurveFile is a pointer to a Parquet file holding raw curve data – the autocorrelation function (ACF) for DLS, the electrophoretic phase/ frequency trace for ELS, or the raw scattering pattern for laser diffraction. These curves are stored as separate files (rather than inline datacubes) because they are large and variable-length. A curve is always tied to the sample (and run) it was measured on via fk_sample/fk_run. Results reference the curve they were derived from via Result.fk_curve; a result with no underlying curve points at a placeholder entry so the foreign key is always satisfied.

Model CurveFile[source]#

Bases: IdsElement

Pointer to a Parquet file containing raw curve data (ACF, ELS time-series, etc.).

Show JSON schema

{
   "description": "Pointer to a Parquet file containing raw curve data (ACF, ELS time-series, etc.).",
   "type": "object",
   "properties": {
      "pk": {
         "@primary_key": true,
         "description": "Primary key for this curve file.",
         "type": "string"
      },
      "file_id": {
         "description": "Identifier of the Parquet file within the Tetra Data Platform.",
         "type": [
            "string",
            "null"
         ]
      },
      "file_name": {
         "description": "Name of the Parquet file.",
         "type": [
            "string",
            "null"
         ]
      },
      "fk_run": {
         "@foreign_key": "/properties/runs/items/properties/pk",
         "description": "Foreign key to the run this curve belongs to.",
         "type": "string"
      },
      "fk_sample": {
         "@foreign_key": "/properties/samples/items/properties/pk",
         "description": "Foreign key to the sample this curve was measured on.",
         "type": "string"
      },
      "description": {
         "description": "Human-readable description of the curve's contents, e.g. 'DLS autocorrelation function'.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "pk",
      "fk_run",
      "fk_sample"
   ]
}

Validators:

field description: str | None#: Human-readable description of the curve’s contents, e.g. ‘DLS autocorrelation function’.

field file_id: str | None#: Identifier of the Parquet file within the Tetra Data Platform.

field file_name: str | None#: Name of the Parquet file.

field fk_run: str#

Foreign key to the run this curve belongs to.

Constraints:

func = <function validate_uuid at 0x7f1493ac61f0>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key

field fk_sample: str#

Foreign key to the sample this curve was measured on.

Constraints:

func = <function validate_uuid at 0x7f1493ac61f0>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key

field pk: str#

Primary key for this curve file.

Constraints:

func = <function validate_uuid at 0x7f1493ac61f0>
json_schema_input_type = PydanticUndefined