AreaSummaryMetric

class rubin_sim.maf.metrics.AreaSummaryMetric(col='metricdata', metric_name='AreaSummary', area=18000.0, decreasing=True, reduce_func=None, **kwargs)

Bases: BaseMetric

Find the min/max of a value in the best area. This is a handy substitute for when users want to know “the WFD value”.

Parameters:

areafloat (18000)

The area to consider (sq degrees)

decreasingbool (True)

Should the values be sorted by increasing or decreasing order. For values where “larger is better”, decreasing is probably what you want. For metrics where “smaller is better” (e.g., astrometric precission), set decreasing to False.

reduce_funcNone

The function to reduce the clipped values by. Will default to min/max depending on the bool val of the decreasing kwarg.

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.