MetricsExample

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

Bases: object

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

Parameters:
summary : dict

Simple dictionary mapping key performance metrics to a scalar result.

output : dict

Structured nested data.

data : list, optional

Arbitrary array data.

Methods Summary

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

Methods Documentation

exportAsDict() → dict

Convert object contents to a single python dict.

classmethod makeFromDict(exportDict: dict) → lsst.daf.butler.tests._examplePythonTypes.MetricsExample

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

Parameters:
exportDict : dict

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

Returns:
newobject : MetricsExample

New MetricsExample object.