VarDepth

class rubin_sim.maf.maf_contrib.VarDepth(m5_col='fiveSigmaDepth', metric_name='variability depth', completeness=0.95, contamination=0.05, numruns=10000, signal=0.01, magres=0.01, **kwargs)

Bases: BaseMetric

Calculate the survey depth that a variable star can be reliably identified.

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.