AgnTimeLagMetric

class rubin_sim.maf.metrics.AgnTimeLagMetric(lag=100, z=1, log=False, threshold=2.2, calc_type='mean', mjd_col='observationStartMJD', filter_col='filter', m5_col='fiveSigmaDepth', dust=True, g_cutoff=22.0, r_cutoff=21.8, metric_name=None, **kwargs)

Bases: BaseMetric

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.