MetricsExample

class lsst.daf.butler.tests.MetricsExample(summary: dict[str, Any] | None = None, output: dict[str, Any] | None = None, data: list[Any] | None = None)

Bases: object

Smorgasboard of information that might be the result of some processing.

Parameters

summarydict

Simple dictionary mapping key performance metrics to a scalar result.

outputdict

Structured nested data.

datalist, optional

Arbitrary array data.

Methods Summary

exportAsDict()	Convert object contents to a single python dict.
from_model(model)	Create metrics from Pydantic model.
makeFromDict(exportDict)	Create a new object from a dict that is compatible with that created by exportAsDict.

Methods Documentation

exportAsDict() → dict[str, list | dict | None]

Convert object contents to a single python dict.

classmethod from_model(model: MetricsExampleModel) → MetricsExample

Create metrics from Pydantic model.

Parameters

modelMetricsExampleModel

Source model.

Returns

newobjectMetricsExample

New MetricsExample object.

classmethod makeFromDict(exportDict: dict[str, list | dict | None]) → MetricsExample

Create a new object from a dict that is compatible with that created by exportAsDict.

Parameters

exportDictdict

dict with keys “summary”, “output”, and (optionally) “data”.

Returns

newobjectMetricsExample

New MetricsExample object.