FONv

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

Bases: BaseMetric

Metrics based on a specified area, but returning NVISITS related to area: given asky, what is the minimum and median number of visits obtained over that much area? (choose the portion of the sky with the highest number of visits first).

Parameters:

colstr or list of strs, optional

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

askyfloat, optional

Area of the sky to base the evaluation of number of visits over. 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.

n_visitint, optional

Number of visits to use as the benchmark value, if choosing to return a normalized n_visit value.

normbool, optional

Normalize the returned “n_visit” (min / median) values by n_visit, if true. Default False.

metricNamestr, optional

Name of the summary metric. Default FONv.

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.