NightTimespanMetric

class rubin_sim.maf.metrics.NightTimespanMetric(percentile=75, night_col='night', mjd_col='observationStartMJD', **kwargs)

Bases: BaseMetric

Calculate the maximum time span covered in each night, report the percentile value of all timespans.

Parameters:

percentilefloat, opt

Percentile value to report. Default 75th percentile.

night_colstr, opt

Name of the night column. Default ‘night’.

mjd_colstr, opt

Name of the MJD visit column. Default ‘observationStartMJD’.

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.