AreaThresholdMetric

class rubin_sim.maf.metrics.AreaThresholdMetric(col='metricdata', metric_name='AreaThreshold', upper_threshold=None, lower_threshold=None, **kwargs)

Bases: BaseMetric

Find the amount of area on the sky that meets a given threshold value.

The area per pixel is determined from the size of the metric_values array passed to the summary metric. This assumes that both all values are passed and that the metric was calculated with a healpix slicer.

Parameters:

upper_thresholdfloat or None

The metric value must be below this threshold to count toward the area. Default None implies no upper bound.

lower_thresholdfloat or None, opt

The metric value must be above this threshold to count toward the area. Default None implies no lower bound.

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.