CumulativeMetric

class rubin_sim.maf.metrics.CumulativeMetric(metric_name='Cumulative', time_col='observationStartMJD', night_col='night', interp_points=None, **kwargs)

Bases: BaseMetric

For plotting up the cumulative number of observations. Expected to be used with a UniSlicer or UserPointSlicer with one point.

Parameters:

interp_pointsnp.array (None)

The points to interpolate the cumulative number of observations to. If None, then the range of the data is used with a stepsize of 1.

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.