ExgalM5WithCuts

class rubin_sim.maf.metrics.ExgalM5WithCuts(m5_col='fiveSigmaDepth', filter_col='filter', metric_name='Exgalm5WithCuts', units='mag', lsst_filter='i', extinction_cut=0.2, depth_cut=25.9, n_filters=6, **kwargs)

Bases: BaseMetric

Calculate co-added five-sigma limiting depth, but apply dust extinction and depth cuts. This means that places on the sky that don’t meet the dust extinction, coadded depth, or filter coverage cuts will have masked values on those places.

This metric is useful for DESC static science and weak lensing metrics. In particular, it is required as input for the StaticProbesFoMEmulatorMetricSimple (a summary metric to emulate a 3x2pt FOM).

Note: this metric calculates the depth after dust extinction in band ‘lsst_filter’, but because it looks for coverage in all bands, there should generally be no filter-constraint on the sql query.

Methods Summary

run(data_slice, slice_point)

Calculate metric values.

Methods Documentation

run(data_slice, slice_point)

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.