FOArea

class rubin_sim.maf.metrics.FOArea(col='metricdata', n_visit=825, asky=18000.0, nside=128, norm=False, metric_name='FOArea', **kwargs)

Bases: BaseMetric

Metrics based on a specified number of visits, but returning AREA related to Nvisits: given n_visit, what amount of sky is covered with at least that many visits?

Parameters:

colstr or list of strs, optional

Name of the column in the numpy recarray passed to the summary metric.

n_visitint, optional

Number of visits to use as the minimum required – metric calculated area that has this many visits. Default 825.

askyfloat, optional

Area to use as the benchmark value, if choosing to returned a normalized Area value. Default 18,0000 sq deg.

nsideint, optional

Nside parameter from healpix slicer, used to set the physical relationship between on-sky area and number of healpixels. Default 128.

normbool, optional

Normalize the returned “area” (area with minimum n_visit visits) value by asky, if true. Default False.

metricNamestr, optional

Name of the summary metric. Default FOArea.

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.