registerMetricsExample

lsst.daf.butler.tests.registerMetricsExample(butler: Butler) → None

Modify a repository to support reading and writing MetricsExample objects.

This method allows MetricsExample to be used with test repositories in any package without needing to provide a custom configuration there.

Parameters:

butlerlsst.daf.butler.Butler

The repository that needs to support MetricsExample.

Notes

This method enables the following storage classes:

StructuredData

A MetricsExample whose summary, output, and data members can be retrieved as dataset components.

StructuredDataNoComponents

A monolithic write of a MetricsExample.

These definitions must match the equivalent definitions in the test YAML files.