MeasurementSet¶
-
class
lsst.verify.
MeasurementSet
(measurements=None)¶ Bases:
lsst.verify.jsonmixin.JsonSerializationMixin
A collection of
Measurement
s ofMetric
s.MeasurementSet
provides a dict-like interface for getting, setting, and iterating overMeasurement
s.Parameters: - measurements :
list
oflsst.verify.Measurement
s Measurements to include in the set.
Attributes Summary
json
A dict
that can be serialized as JSON.Methods Summary
deserialize
([measurements, blob_set, metric_set])Create a measurement set from a parsed JSON dataset. insert
(measurement)Insert a measurement into the set. items
()Iterete over ( Name
,Measurement
) pairs in the set.jsonify_dict
(d)Recursively build JSON-renderable objects on all values in a dict. keys
()Get a sequence of metric names contained in the measurement set. refresh_metrics
(metric_set)Refresh Measurement.metric
attributes inMeasurement
s contained by this set.update
(other)Merge another MeasurementSet
into this one.write_json
(filepath)Write JSON to a file. Attributes Documentation
Methods Documentation
-
classmethod
deserialize
(measurements=None, blob_set=None, metric_set=None)¶ Create a measurement set from a parsed JSON dataset.
Parameters: - measurements :
list
, optional A list of
Measurement
JSON serializations.- blob_set :
BlobSet
, optional A
BlobSet
instance that support measurement deserialization.- metric_set :
MetricSet
, optional A
MetricSet
that supports measurement deserialization. If provided, measurements are validated for unit consistency with metric definitions.Measurement
instances also gain aMeasurement.metric
attribute.
Returns: - instance :
MeasurementSet
A
MeasurementSet
instance.
- measurements :
-
insert
(measurement)¶ Insert a measurement into the set.
-
items
()¶ Iterete over (
Name
,Measurement
) pairs in the set.Yields: - item :
tuple
Tuple containing:
Name
of the measurement’sMetric
.Measurement
instance.
- item :
-
static
jsonify_dict
(d)¶ Recursively build JSON-renderable objects on all values in a dict.
Parameters: - d :
dict
Dictionary to convert into a JSON-serializable object. Values are recursively JSON-ified.
Returns: - json_dict :
dict
Dictionary that can be serialized to JSON.
Examples
Subclasses can use this method to prepare output in their
json
-method implementation. For example:def json(self): return JsonSerializationMixin.jsonify_dict({ 'value': self.value, })
- d :
-
keys
()¶ Get a sequence of metric names contained in the measurement set.
Returns: - keys : sequence of
Name
Sequence of names of metrics for measurements in the set.
- keys : sequence of
-
refresh_metrics
(metric_set)¶ Refresh
Measurement.metric
attributes inMeasurement
s contained by this set.Parameters: - metric_set :
MetricSet
Metric
s from this set are inserted into correspondingMeasurement
s contained in thisMeasurementSet
.
Notes
This method is especially useful for inserting
Metric
instances intoMeasurement
s that weren’t originally created withMetric
instances. By including aMetric
in aMeasurement
, the serialized units of a measurment are normalized to the metric’s definition.- metric_set :
-
update
(other)¶ Merge another
MeasurementSet
into this one.Parameters: - other :
MeasurementSet
Another
MeasurementSet
. Measurements inother
that do exist in this set are added to this one. Measurements inother
replace measurements of the same metric in this one.
- other :
- measurements :