XRBPopMetric

class rubin_sim.maf.maf_contrib.XRBPopMetric(metric_name='XRBPopMetric', mjd_col='observationStartMJD', m5_col='fiveSigmaDepth', filter_col='filter', night_col='night', pts_needed=2, mjd0=None, output_lc=False, badval=-666, **kwargs)

Bases: BaseMetric

Methods Summary

reduce_early_detect(metric)
reduce_ever_detect(metric)
reduce_mean_time_between_detections(metric)
reduce_number_of_detections(metric)
reduce_possible_to_detect(metric)
run(data_slice[, slice_point])	Calculate metric values.

Methods Documentation

reduce_early_detect(metric)

reduce_ever_detect(metric)

reduce_mean_time_between_detections(metric)

reduce_number_of_detections(metric)

reduce_possible_to_detect(metric)

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.