phenotypic.analysis.RelativeMAD#

class phenotypic.analysis.RelativeMAD(*, on: ~typing.Annotated[str, _ColumnRefMarker('measurements')], groupby: ~typing.Annotated[list[str], _ColumnRefMarker('measurements')], agg_func: ~typing.Callable | str | list | dict | None = 'mean', n_jobs: int = 1, warn_threshold: float = 0.1, fail_threshold: float = 0.2, unmatched_groups: list = <factory>, time_label: ~typing.Annotated[str, _ColumnRefMarker('measurements')] = 'MetadataCulture_Time', min_replicates: int = 2, eps: float = 1e-09)[source]#

Bases: QualityCheck

Flag (group, time) bins with poor robust agreement across replicates.

For each combination of self.groupby columns, this check splits the group by self.time_label and computes the median absolute deviation (MAD) of the measurement across replicates at every timepoint. The relative MAD metric = MAD / |median| is the per-bin metric; bins whose metric exceeds the warn/fail thresholds are surfaced for curation. The per-bin scalars are broadcast back to every replicate row in the bin so the GUI can pick up the flag from any row.

Because the MAD has a 50% breakdown point, the metric stays accurate even when up to half the replicates in a bin are contaminated — a single mis-segmented or contaminated colony will not inflate it the way it inflates the relative standard error. It is therefore the robust counterpart to ReplicateAgreement.

_HIGHER_IS_BAD is True: a larger relative MAD means worse replicate agreement, so the base class flags rows whose metric meets or exceeds fail_threshold.

Three guard paths short-circuit to metric = NaN so under-powered or degenerate bins never gate curation (the base class treats NaN metric as Status="pass"):

``n < min_replicates`` — too few replicates for a meaningful spread estimate. Defaults to min_replicates=2; raising it lets callers demand more statistical power.

``|median| < eps`` — the relative-MAD ratio blows up at zero median, so near-zero baseline measurements (t=0 wells, blank wells, true-zero conditions) would otherwise flag every row. The default eps=1e-9 catches sensor-zero readouts without losing genuinely-above-noise-floor measurements.

``MAD == 0`` and ``median == 0`` — degenerate bin (all replicates exactly zero); mathematically undefined. Treated as pass.

When self.time_label is absent from the input data, the entire group is treated as a single timepoint bin so the check remains usable on snapshot (non-time-course) measurement frames.

The check does not aggregate measurement values — it builds the median/MAD summary statistics inside _compute() — so _exposes_agg_func is False and the GUI parameter-form rendering driver hides the agg_func field. The base SetAnalyzer.agg_func is preserved on the signature for parity only.
Attributes:

time_label: Column name carrying the timepoint within each
group. Defaults to "MetadataCulture_Time".

min_replicates: Minimum replicate count required before the MAD
is considered meaningful. Bins below this threshold receive metric = NaN.

eps: Floor on |median| below which the relative-MAD ratio is
considered undefined. Bins below this floor receive metric = NaN.

warn_threshold: Relative MAD at which Status becomes
"warn". Defaults to 0.10.

fail_threshold: Relative MAD at which Status becomes
"fail" and Flag=True. Defaults to 0.20.

Examples:
Basic — three-replicate, four-timepoint synthetic frame; the check adds QC_MAD_Metric plus the per-bin summary columns:
>>> import pandas as pd
>>> from phenotypic.analysis.qc import RelativeMAD
>>> times = [0, 1, 2, 3]
>>> data = pd.DataFrame({
...     "Plate": ["P1"] * 12,
...     "MetadataCulture_Time": [t for t in times for _ in range(3)],
...     "Replicate": [1, 2, 3] * 4,
...     "Size_Area": [
...         10.0, 10.1, 9.9,
...         20.0, 20.2, 19.8,
...         40.0, 40.4, 39.6,
...         80.0, 80.8, 79.2,
...     ],
... })
>>> chk = RelativeMAD(
...     on="Size_Area",
...     groupby=["Plate"],
...     time_label="MetadataCulture_Time",
... )
>>> result = chk.analyze(data)
>>> "QC_MAD_Metric" in result.columns
True
Advanced — only one replicate per (group, time) bin with min_replicates=2 triggers the under-powered guard:
>>> singleton = pd.DataFrame({
...     "Plate": ["P1", "P1"],
...     "MetadataCulture_Time": [0, 1],
...     "Size_Area": [10.0, 20.0],
... })
>>> chk = RelativeMAD(
...     on="Size_Area",
...     groupby=["Plate"],
...     min_replicates=2,
... )
>>> result = chk.analyze(singleton)
>>> bool(result["QC_MAD_Metric"].isna().all())
True

Category: **QC_MAD**#
Name	Description	Type
`QC_MAD_Flag`	True when the metric crosses fail_threshold in the bad direction; eligible for curation.	Quality
`QC_MAD_Metric`	Headline metric in the check’s own units; the bad direction is set by the check’s _HIGHER_IS_BAD flag. Drives Status.	Quality
`QC_MAD_Status`	Categorical: pass \| warn \| fail.	Quality

Methods

`__init__`	Create a new model by parsing and validating input data from keyword arguments.
`analyze`	Run the check on every group and return the augmented frame.
`construct`
`copy`	Returns a copy of the model.
`dash`	Interactive Plotly visualization of analysis results.
`dict`
`flag_col`	Return the flag column name for this check.
`flagged_keys`	Return (`Metadata_ImageName`, `Object_Label`) pairs to curate.
`from_orm`
`group_members`	Map each group key to its member rows for worklists/galleries.
`json`
`metric_col`	Return the metric column name for this check.
`model_construct`	Creates a new instance of the Model class with validated data.
`model_copy`	!!! abstract "Usage Documentation"
`model_dump`	!!! abstract "Usage Documentation"
`model_dump_json`	!!! abstract "Usage Documentation"
`model_json_schema`	Generates a JSON schema for a model class.
`model_parametrized_name`	Compute the class name for parametrizations of generic classes.
`model_post_init`	This function is meant to behave like a BaseModel method to initialise private attributes.
`model_rebuild`	Try to rebuild the pydantic-core schema for the model.
`model_validate`	Validate a pydantic model instance.
`model_validate_json`	!!! abstract "Usage Documentation"
`model_validate_strings`	Validate the given object with string data against the Pydantic model.
`parse_file`
`parse_obj`
`parse_raw`
`results`	Return the augmented frame stored by the most recent analyze().
`schema`
`schema_json`
`show`	QualityCheck plots are Plotly-only — see `dash()`.
`status_col`	Return the status column name for this check.
`summary`	Return a one-row-per-group summary of the most recent analyze.
`table_spec`	Return the catalog descriptor for this analyzed check.
`to_table`	Return the module's self-describing frame to persist to DuckDB.
`update_forward_refs`
`validate`

Attributes

`member_key_cols`	Per-object curation-key columns.
`model_computed_fields`
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_extra`	Get extra fields set during validation.
`model_fields`
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`name`
`supports_object_curation`	Whether this check's rows map to curatable detected objects.
`warn_threshold`
`fail_threshold`
`time_label`
`min_replicates`
`eps`
`unmatched_groups`
`on`
`groupby`
`agg_func`
`n_jobs`

Parameters:

on (Annotated[str, _ColumnRefMarker('measurements')])
groupby (Annotated[list[str], _ColumnRefMarker('measurements')])
agg_func (Callable | str | list | dict | None)
n_jobs (int)
warn_threshold (float)
fail_threshold (float)
unmatched_groups (list)
time_label (Annotated[str, _ColumnRefMarker('measurements')])
min_replicates (int)
eps (float)

name: ClassVar[str] = 'MAD'#

warn_threshold: float#

fail_threshold: float#

time_label: ColumnRef#

min_replicates: int#

eps: float#

__copy__() → Self#

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo: dict[int, Any] | None = None) → Self#

Returns a deep copy of the model.

Parameters:: memo (dict[int, Any] | None)
Return type:: Self

classmethod __get_pydantic_json_schema__(core_schema: CoreSchema, handler: GetJsonSchemaHandler, /) → JsonSchemaValue#

Hook into generating the model’s JSON schema.

Parameters:

core_schema (CoreSchema) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Returns:

A JSON schema, as a Python object.

Return type:

JsonSchemaValue

__init__(**data: Any) → None#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:: data (Any)
Return type:: None

classmethod __init_subclass__(**kwargs: Any) → None#

Append QC and per-check RST tables to the subclass docstring.

Skips intermediate ABCs that have not yet bound name. When the subclass declares both a docstring and a name, the generic QUALITY_CHECK table is appended (substituting name into the column headers). If _measurement_infoclass is also set, its table is appended as well so check-specific columns are documented alongside the generic trio.

Parameters:: kwargs (Any)
Return type:: None

__iter__() → Generator[tuple[str, Any], None, None]#

So dict(model) works.

Return type:: Generator[tuple[str, Any], None, None]

__pretty__(fmt: Callable[[Any], Any], **kwargs: Any) → Generator[Any]#

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Parameters:

fmt (Callable[[Any], Any])
kwargs (Any)

Return type:

Generator[Any]

classmethod __pydantic_init_subclass__(**kwargs: Any) → None#

Populate field descriptions from the subclass docstring.

Runs once per concrete subclass after pydantic has built its model, copying parameter descriptions parsed from the Google-style Args: docstring block onto each field’s description slot.

Parameters:: **kwargs (Any) – Class-keyword arguments forwarded by pydantic.
Return type:: None

classmethod __pydantic_on_complete__() → None#

This is called once the class and its fields are fully initialized and ready to be used.

This typically happens when the class is created (just before [__pydantic_init_subclass__()][pydantic.main.BaseModel.__pydantic_init_subclass__] is called on the superclass), except when forward annotations are used that could not immediately be resolved. In that case, it will be called later, when the model is rebuilt automatically or explicitly using [model_rebuild()][pydantic.main.BaseModel.model_rebuild].

Return type:: None

__repr_name__() → str#

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_recursion__(object: Any) → str#

Returns the string representation of a recursive object.

Parameters:: object (Any)
Return type:: str

__rich_repr__() → RichReprResult#

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: RichReprResult

analyze(data: pandas.DataFrame) → pandas.DataFrame#

Run the check on every group and return the augmented frame.

Iterates over data.groupby(self.groupby, dropna=False), delegates per-group computation to _compute(), and adds three generic columns derived from the metric:

QC_<name>_Metric (carry-through from _compute)
QC_<name>_Flag (bool)
QC_<name>_Status ("pass" / "warn" / "fail")

Flag and Status are directional. With _HIGHER_IS_BAD=True a row fails when metric >= fail_threshold and warns when metric >= warn_threshold; with _HIGHER_IS_BAD=False the comparisons invert to <=. A NaN metric always yields Status="pass" and Flag=False.

Rows are never dropped. The augmented frame is stored on _latest_measurements and returned.

Parameters:: data (pandas.DataFrame) – Input measurement frame. Must contain self.on and every column in self.groupby.
Returns:: The input frame with the three generic QC columns appended plus whatever _compute contributed.
Raises:: KeyError – If self.on or any column in self.groupby is missing from data.
Return type:: pandas.DataFrame

classmethod construct(_fields_set: set[str] | None = None, **values: Any) → Self#

Parameters:

_fields_set (set[str] | None)
values (Any)

Return type:

Self

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to include in the copied model.
exclude (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to exclude in the copied model.
update (Dict[str, Any] | None) – Optional dictionary of field-value pairs to override field values in the copied model.
deep (bool) – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

Return type:

Self

dash(**kwargs)#

Interactive Plotly visualization of analysis results.

Subclasses may override this method to provide an interactive Plotly figure equivalent to show().

Raises:: NotImplementedError – Unless overridden by a subclass.

Parameters:

include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None)
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None)
by_alias (bool)
exclude_unset (bool)
exclude_defaults (bool)
exclude_none (bool)

Return type:

Dict[str, Any]

classmethod flag_col() → str#

Return the flag column name for this check.

Return type:: str

flagged_keys() → list[tuple[str, int]]#

Return (Metadata_ImageName, Object_Label) pairs to curate.

Used by the GUI “Mark all flagged for removal” button. Requires the analyzed frame to carry both Metadata_ImageName and Object_Label columns (the curation key used by STORE_REMOVED_KEYS). Returns an empty list when those columns are absent or when no rows were flagged.

Returns:: De-duplicated list of (image_file, object_label) tuples for rows where Flag=True.
Return type:: list[tuple[str, int]]

classmethod from_orm(obj: Any) → Self#

Parameters:: obj (Any)
Return type:: Self

group_members() → dict[tuple, list[tuple[str, int, Any]]]#

Map each group key to its member rows for worklists/galleries.

Walks the most recent analyzed frame and, for every group key produced by data.groupby(self.groupby, dropna=False), collects the rows that belong to it as (Metadata_ImageName, Object_Label, member_value) tuples, where member_value is the row’s self.on value (the column the check operates on). The mapping preserves group iteration order.

Mirrors flagged_keys()’s guard: if the analyzed frame lacks either Metadata_ImageName or the object-label column, an empty mapping is returned rather than raising.

Returns:: Ordered mapping of group key (always a tuple, even for a single groupby column) to a list of (image_file, object_label, member_value) tuples. Empty when the curation key columns are absent.
Return type:: dict[tuple, list[tuple[str, int, Any]]]

Parameters:

include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None)
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None)
by_alias (bool)
exclude_unset (bool)
exclude_defaults (bool)
exclude_none (bool)
encoder (Callable[[Any], Any] | None)
models_as_dict (bool)
dumps_kwargs (Any)

Return type:

str

member_key_cols: ClassVar[tuple[str, ...]] = ('MetadataImage_ImageName', 'Object_Label')#: Per-object curation-key columns. Empty tuple when the check has no per-object key. Subclasses may narrow this.

classmethod metric_col() → str#

Return the metric column name for this check.

Return type:: str

model_computed_fields = {}#

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) → Self#

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

Return type:

Self

model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) → Self#

!!! abstract “Usage Documentation”: [model_copy](../concepts/models.md#model-copy)

Returns a copy of the model.

!!! note: The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:

update (Mapping[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Returns:

New model instance.

Return type:

Self

!!! abstract “Usage Documentation”: [model_dump](../concepts/serialization.md#python-mode)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Literal['json', 'python'] | str) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to include in the output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Returns:

A dictionary representation of the model.

Return type:

dict[str, Any]

!!! abstract “Usage Documentation”: [model_dump_json](../concepts/serialization.md#json-mode)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
ensure_ascii (bool) – If True, the output is guaranteed to have all incoming non-ASCII characters escaped. If False (the default), these characters will be output as-is.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to include in the JSON output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Returns:

A JSON string representation of the model.

Return type:

str

property model_extra: dict[str, Any] | None#

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields = {'agg_func': FieldInfo(annotation=Union[Callable, str, list, dict, NoneType], required=False, default='mean'), 'eps': FieldInfo(annotation=float, required=False, default=1e-09, description='Floor on ``|median|`` below which the relative-MAD ratio is considered undefined. Bins below this floor receive ``metric = NaN``.'), 'fail_threshold': FieldInfo(annotation=float, required=False, default=0.2, description='Relative MAD at which ``Status`` becomes ``"fail"`` and ``Flag=True``. Defaults to ``0.20``.'), 'groupby': FieldInfo(annotation=list[str], required=True, metadata=[_ColumnRefMarker('measurements')]), 'min_replicates': FieldInfo(annotation=int, required=False, default=2, description='Minimum replicate count required before the MAD is considered meaningful. Bins below this threshold receive ``metric = NaN``.'), 'n_jobs': FieldInfo(annotation=int, required=False, default=1, alias_priority=2, validation_alias=AliasChoices(choices=['n_jobs', 'num_workers'])), 'on': FieldInfo(annotation=str, required=True, metadata=[_ColumnRefMarker('measurements')]), 'time_label': FieldInfo(annotation=str, required=False, default='MetadataCulture_Time', description='Column name carrying the timepoint within each group. Defaults to ``"MetadataCulture_Time"``.', metadata=[_ColumnRefMarker('measurements')]), 'unmatched_groups': FieldInfo(annotation=list, required=False, default_factory=list, description='Groups that the check could not evaluate (for example, expected counts whose group key never appeared in the data). Populated by subclasses that need to report missing combinations; empty by default.'), 'warn_threshold': FieldInfo(annotation=float, required=False, default=0.1, description='Relative MAD at which ``Status`` becomes ``"warn"``. Defaults to ``0.10``.')}#

property model_fields_set: set[str]#

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias: bool = True, ref_template: str = '#/$defs/{model}', schema_generator: type[~pydantic.json_schema.GenerateJsonSchema] = <class 'pydantic.json_schema.GenerateJsonSchema'>, mode: ~typing.Literal['validation', 'serialization'] = 'validation', *, union_format: ~typing.Literal['any_of', 'primitive_type_array'] = 'any_of') → dict[str, Any]#

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
union_format (Literal['any_of', 'primitive_type_array']) –
The format to use when combining schemas from unions together. Can be one of:
- ’any_of’: Use the [anyOf](https://json-schema.org/understanding-json-schema/reference/combining#anyOf)
keyword to combine schemas (the default). - ‘primitive_type_array’: Use the [type](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (string, boolean, null, integer or number) or contains constraints/metadata, falls back to any_of.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Returns:

The JSON schema for the given model class.

Return type:

dict[str, Any]

classmethod model_parametrized_name(params: tuple[type[Any], ...]) → str#

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.
Return type:: str

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

self (BaseModel) – The BaseModel instance.
context (Any) – The context.

Return type:

None

classmethod model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) → bool | None#

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (MappingNamespace | None) – The types namespace, defaults to None.

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

Return type:

bool | None

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError – If the object could not be validated.

Returns:

The validated model instance.

Return type:

Self

!!! abstract “Usage Documentation”: [JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

Return type:

Self

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Return type:

Self

classmethod parse_file(path: str | Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) → Self#

Parameters:

path (str | Path)
content_type (str | None)
encoding (str)
proto (DeprecatedParseProtocol | None)
allow_pickle (bool)

Return type:

Self

classmethod parse_obj(obj: Any) → Self#

Parameters:: obj (Any)
Return type:: Self

classmethod parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) → Self#

Parameters:

b (str | bytes)
content_type (str | None)
encoding (str)
proto (DeprecatedParseProtocol | None)
allow_pickle (bool)

Return type:

Self

results() → pandas.DataFrame#

Return the augmented frame stored by the most recent analyze().

Return type:: pandas.DataFrame

classmethod schema(by_alias: bool = True, ref_template: str = '#/$defs/{model}') → Dict[str, Any]#

Parameters:

by_alias (bool)
ref_template (str)

Return type:

Dict[str, Any]

classmethod schema_json(*, by_alias: bool = True, ref_template: str = '#/$defs/{model}', **dumps_kwargs: Any) → str#

Parameters:

by_alias (bool)
ref_template (str)
dumps_kwargs (Any)

Return type:

str

show(*args: Any, **kwargs: Any) → Any#

QualityCheck plots are Plotly-only — see dash().

SetAnalyzer’s matplotlib show() is not implemented for QC because the QC tab is Plotly-driven. Raising rather than falling back to a placeholder so notebook users discover the right method.

Raises:

NotImplementedError – Always; use dash() instead.

Parameters:

args (Any)
kwargs (Any)

Return type:

Any

classmethod status_col() → str#

Return the status column name for this check.

Return type:: str

summary() → pandas.DataFrame#

Return a one-row-per-group summary of the most recent analyze.

The aggregate columns are prefixed with ``qc_`` so they can never collide with a groupby column on reset_index — a plate-layout column literally named status or num_rows would otherwise raise. The summary therefore always carries the group key columns plus the four prefixed aggregates.

Returns:: DataFrame with columns [*self.groupby, "qc_n_members", "qc_n_flagged", "qc_worst_metric", "qc_status"]. qc_worst_metric is the extreme metric value in the bad direction across the group: group[metric_col].max() when _HIGHER_IS_BAD is True, else group[metric_col].min(). qc_status is the worst status across the group: "fail" wins over "warn" which wins over "pass".
Return type:: pandas.DataFrame

supports_object_curation: ClassVar[bool] = True#: Whether this check’s rows map to curatable detected objects. False for diagnostic-only checks (e.g. GridOccupancy) — the Review tab hides the curation radial + tile gallery and verified-good skips them.

table_spec(instance_id: str) → QcTableSpec#

Return the catalog descriptor for this analyzed check.

Precondition: analyze() has run. Reads column roles from the class + instance config and derives extra_cols from the augmented frame.

Parameters:: instance_id (str) – The recipe entry id this check was built from.
Returns:: A populated QcTableSpec.
Return type:: QcTableSpec

to_table() → pandas.DataFrame#

Return the module’s self-describing frame to persist to DuckDB.

Precondition: analyze() has run (this reads _latest_measurements). The default is member-level: the augmented frame projected to group-key + member-key + on + every QC_<name>_* column (metric/flag/status AND check-specific extras) + context columns (Metadata_Dataset and the column named by self.time_label) when those columns are present.

Diagnostic-only checks override to return a group-level frame.

Returns:: The projected DataFrame; columns vary per check (self-describing).
Return type:: pandas.DataFrame

classmethod update_forward_refs(**localns: Any) → None#

Parameters:: localns (Any)
Return type:: None

classmethod validate(value: Any) → Self#

Parameters:: value (Any)
Return type:: Self

unmatched_groups: list#

on: ColumnRef#

groupby: ColumnRefList#

agg_func: Callable | str | list | dict | None#

n_jobs: int#

phenotypic.analysis.RelativeMAD#

This Page