PeriodicMetric

class rubin_sim.maf.maf_contrib.PeriodicMetric(time_col='expMJD', **kwargs)

Bases: BaseMetric

From a set of observation times, uses code provided by Robert Siverd (LCOGT) to calculate the spectral window function.

Methods Summary

reduce_peak(data)

reduce_sum(data)

run(data_slice[, slice_point])

Calculate metric values.

Methods Documentation

reduce_peak(data)
reduce_sum(data)
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.