ts_ids_components.flow_cytometry.statistic module

Model Statistic

Bases: IdsElement

A statistic value calculated for a population in flow cytometry analysis.

Statistics represent computed measurements such as count, frequency, mean, median, CV, etc. for a given population.

Show JSON schema

{
   "description": "A statistic value calculated for a population in flow cytometry analysis.\n\nStatistics represent computed measurements such as count, frequency, mean,\nmedian, CV, etc. for a given population.",
   "type": "object",
   "properties": {
      "pk": {
         "description": "Primary key UUID for this statistic.",
         "type": "string"
      },
      "name": {
         "description": "The name of the statistic (e.g., 'Mean', 'Count', 'Frequency of Parent').",
         "type": [
            "string",
            "null"
         ]
      },
      "value": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "The numeric value of the statistic with unit and raw value preservation."
      },
      "fk_sample": {
         "description": "Foreign key UUID linking to the sample.",
         "type": "string"
      },
      "fk_population": {
         "description": "Foreign key UUID linking to the population this statistic belongs to.",
         "type": "string"
      },
      "ancestor_analysis_path": {
         "description": "The analysis path of the ancestor population for frequency-of calculations.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "definitions": {
      "RawValueUnit": {
         "additionalProperties": false,
         "description": "A value with a unit, including the raw representation of the value from the primary data.",
         "properties": {
            "value": {
               "description": "A numerical value.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit for the numerical value.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "raw_value": {
               "description": "The raw, untransformed value from the primary data.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "value",
            "unit",
            "raw_value"
         ],
         "type": "object"
      }
   }
}

Validators:

field ancestor_analysis_path: str | None

The analysis path of the ancestor population for frequency-of calculations.

field fk_population: UUID

Foreign key UUID linking to the population this statistic belongs to.

field fk_sample: UUID

Foreign key UUID linking to the sample.

field name: str | None

The name of the statistic (e.g., ‘Mean’, ‘Count’, ‘Frequency of Parent’).

field pk: UUID

Primary key UUID for this statistic.

field value: RawValueUnit

The numeric value of the statistic with unit and raw value preservation.