Source code for ts_ids_components.flow_cytometry.statistic

from uuid import UUID

from ts_ids_core.annotations import Nullable
from ts_ids_core.base.ids_element import IdsElement
from ts_ids_core.base.ids_field import IdsField
from ts_ids_core.schema import RawValueUnit




class Statistic(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.
    """

    pk: UUID = IdsField(description="Primary key UUID for this statistic.")
    name: Nullable[str] = IdsField(
        description="The name of the statistic (e.g., 'Mean', 'Count', 'Frequency of Parent')."
    )
    value: RawValueUnit = IdsField(
        description="The numeric value of the statistic with unit and raw value preservation."
    )
    fk_sample: UUID = IdsField(description="Foreign key UUID linking to the sample.")
    fk_population: UUID = IdsField(
        description="Foreign key UUID linking to the population this statistic belongs to."
    )
    ancestor_analysis_path: Nullable[str] = IdsField(
        description="The analysis path of the ancestor population for frequency-of calculations."
    )