ts_ids_components.flow_cytometry.gate module#

Bases: IdsElement

A gate definition used in flow cytometry gating strategies.

Gates define regions on flow cytometry plots to select cell populations. Gates can be hierarchical, with child gates referencing parent gates via parent_gate_id. Gate types include PolygonGate, RectangleGate, EllipsoidGate, and others.

Show JSON schema

{
   "description": "A gate definition used in flow cytometry gating strategies.\n\nGates define regions on flow cytometry plots to select cell populations.\nGates can be hierarchical, with child gates referencing parent gates via parent_gate_id.\nGate types include PolygonGate, RectangleGate, EllipsoidGate, and others.",
   "type": "object",
   "properties": {
      "pk": {
         "description": "Primary key UUID for this gate.",
         "type": "string"
      },
      "id": {
         "description": "The unique identifier of the gate from the source system.",
         "type": [
            "string",
            "null"
         ]
      },
      "parent_gate_id": {
         "description": "The identifier of the parent gate, establishing the gating hierarchy.",
         "type": [
            "string",
            "null"
         ]
      },
      "type_": {
         "description": "The type of gate (e.g., 'PolygonGate', 'RectangleGate', 'EllipsoidGate').",
         "type": [
            "string",
            "null"
         ]
      },
      "x_axis_name": {
         "description": "The name of the x-axis parameter used for this gate.",
         "type": [
            "string",
            "null"
         ]
      },
      "y_axis_name": {
         "description": "The name of the y-axis parameter used for this gate.",
         "type": [
            "string",
            "null"
         ]
      },
      "minimum_x_coordinate": {
         "description": "The minimum x-coordinate boundary of the gate (for rectangle gates).",
         "type": [
            "number",
            "null"
         ]
      },
      "maximum_x_coordinate": {
         "description": "The maximum x-coordinate boundary of the gate (for rectangle gates).",
         "type": [
            "number",
            "null"
         ]
      },
      "minimum_y_coordinate": {
         "description": "The minimum y-coordinate boundary of the gate (for rectangle gates).",
         "type": [
            "number",
            "null"
         ]
      },
      "maximum_y_coordinate": {
         "description": "The maximum y-coordinate boundary of the gate (for rectangle gates).",
         "type": [
            "number",
            "null"
         ]
      },
      "vertices_x": {
         "description": "List of x-coordinates for polygon and ellipsoid gate vertices.",
         "items": {
            "type": "number"
         },
         "type": "array"
      },
      "vertices_y": {
         "description": "List of y-coordinates for polygon and ellipsoid gate vertices.",
         "items": {
            "type": "number"
         },
         "type": "array"
      },
      "ellipsoid_focal_points_x": {
         "description": "List of x-coordinates for ellipsoid gate focal points.",
         "items": {
            "type": "number"
         },
         "type": "array"
      },
      "ellipsoid_focal_points_y": {
         "description": "List of y-coordinates for ellipsoid gate focal points.",
         "items": {
            "type": "number"
         },
         "type": "array"
      },
      "distance": {
         "description": "The distance parameter of the ellipsoid gate.",
         "type": [
            "number",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

field distance: Decimal | None#: The distance parameter of the ellipsoid gate.

field ellipsoid_focal_points_x: List[float]#: List of x-coordinates for ellipsoid gate focal points.

field ellipsoid_focal_points_y: List[float]#: List of y-coordinates for ellipsoid gate focal points.

field id_: str | None (alias 'id')#: The unique identifier of the gate from the source system.

field maximum_x_coordinate: float | None#: The maximum x-coordinate boundary of the gate (for rectangle gates).

field maximum_y_coordinate: float | None#: The maximum y-coordinate boundary of the gate (for rectangle gates).

field minimum_x_coordinate: float | None#: The minimum x-coordinate boundary of the gate (for rectangle gates).

field minimum_y_coordinate: float | None#: The minimum y-coordinate boundary of the gate (for rectangle gates).

field parent_gate_id: str | None#: The identifier of the parent gate, establishing the gating hierarchy.

field pk: UUID#: Primary key UUID for this gate.

field type_: str | None#: The type of gate (e.g., ‘PolygonGate’, ‘RectangleGate’, ‘EllipsoidGate’).

field vertices_x: List[float]#: List of x-coordinates for polygon and ellipsoid gate vertices.

field vertices_y: List[float]#: List of y-coordinates for polygon and ellipsoid gate vertices.

field x_axis_name: str | None#: The name of the x-axis parameter used for this gate.

field y_axis_name: str | None#: The name of the y-axis parameter used for this gate.