MeasurementNotes¶
- class lsst.verify.MeasurementNotes(metric_name)¶
Bases:
object
Container for annotations (notes) associated with a single
lsst.verify.Measurement
.Typically you will use pre-instantiate
MeasurementNotes
objects through thelsst.verify.Measurement.notes
attribute.- Parameters:
Examples
MeasurementNotes
implements adict
-like interface. The only difference is that, internally, keys are always prefixed with the name of a metric. This allows measurement annotations to meshlsst.verify.Job
metadata keys (lsst.verify.Job.meta
).Users of
MeasurementNotes
, typically thoughMeasurement.notes
, do not need to use this prefix. Keys are prefixed behind the scenes.>>> notes = MeasurementNotes('validate_drp') >>> notes['filter_name'] = 'r' >>> notes['filter_name'] 'r' >>> notes['validate_drp.filter_name'] 'r' >>> print(notes) {'validate_drp.filter_name': 'r'}
Methods Summary
items
()Iterate over note key-value pairs.
keys
()Get key names.
update
(data)Update the notes with key-value pairs from a
dict
-like object.Methods Documentation
- items()¶
Iterate over note key-value pairs.
- Yields:
- itemkey-value pair
Each items is tuple of:
Key name (
str
).Note value (object).