ts_ids_components.flow_cytometry.population module

Model Population

Bases: IdsElement

A population representing a subset of cells selected by gating in flow cytometry.

Populations are created by applying gates to samples and can be hierarchical. Each population references its parent sample and the gate method used to define it.

Show JSON schema

{
   "description": "A population representing a subset of cells selected by gating in flow cytometry.\n\nPopulations are created by applying gates to samples and can be hierarchical.\nEach population references its parent sample and the gate method used to define it.",
   "type": "object",
   "properties": {
      "pk": {
         "description": "Primary key UUID for this population.",
         "type": "string"
      },
      "name": {
         "description": "The name of the cellular/particle population (e.g., CD4+, CD8+, etc).",
         "type": [
            "string",
            "null"
         ]
      },
      "count_": {
         "description": "The number of events (cells/particles) in this population.",
         "type": [
            "integer",
            "null"
         ]
      },
      "analysis_path": {
         "description": "The full hierarchical path to this population (e.g., 'Lymphocytes/CD4+/CD8-').",
         "type": [
            "string",
            "null"
         ]
      },
      "parent_analysis_path": {
         "description": "The analysis path of the parent population.",
         "type": [
            "string",
            "null"
         ]
      },
      "fk_sample": {
         "description": "Foreign key UUID linking to the sample this population belongs to.",
         "type": "string"
      },
      "fk_method_gate": {
         "description": "Foreign key UUID linking to the gate method used to define this population.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

field analysis_path: str | None

The full hierarchical path to this population (e.g., ‘Lymphocytes/CD4+/CD8-‘).

field count_: int | None

The number of events (cells/particles) in this population.

field fk_method_gate: UUID | None

Foreign key UUID linking to the gate method used to define this population.

field fk_sample: UUID

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

field name: str | None

The name of the cellular/particle population (e.g., CD4+, CD8+, etc).

field parent_analysis_path: str | None

The analysis path of the parent population.

field pk: UUID

Primary key UUID for this population.