HourglassMetric

class rubin_sim.maf.metrics.HourglassMetric(telescope='LSST', mjd_col='observationStartMJD', filter_col='filter', night_col='night', delta_t=60.0, **kwargs)

Bases: BaseMetric

Plot the filters used as a function of time. Must be used with the Hourglass Slicer. Will totally fail in the arctic circle.

Methods Summary

run(data_slice[, slice_point])

Calculate metric values.

Methods Documentation

run(data_slice, slice_point=None)

Calculate metric values.

Parameters:

data_slicenumpy.recarray

Values passed to metric by the slicer, which the metric will use to calculate metric values at each slice_point.

slice_pointdict or None

Dictionary of slice_point metadata passed to each metric. E.g. the ra/dec of the healpix pixel or opsim fieldId.

Returns:

metricValue: int float or object

The metric value at each slice_point.