class rubin_sim.maf.metrics.FootprintFraction(footprint=None, metric_name='FootprintFraction', n_min=1, **kwargs)

Bases: BaseMetric

Find what fraction of a desired footprint got covered. Helpful to check if everything was covered in first year

n_minint (1)

The number of visits to require to consider an area covered

footprintnp.array (None)

The HEALpix footprint to compare to. The nside of the footprint should match the nside of the slicer.

Methods Summary

run(data_slice[, slice_point])

Calculate metric values.

Methods Documentation

run(data_slice, slice_point=None)

Calculate metric values.


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.

metricValue: int float or object

The metric value at each slice_point.