InterNightGapsMetric

class rubin_sim.maf.metrics.InterNightGapsMetric(mjd_col='observationStartMJD', night_col='night', reduce_func=<function median>, metric_name='Median Inter-Night Gap', **kwargs)

Bases: BaseMetric

Calculate the (reduce_func) of the gap between consecutive observations in different nights, in days.

Parameters:

reduce_funcfunction, optional

Function that can operate on array-like structures. Typically numpy function. Default np.median.

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.