NumObsMetric

class rubin_sim.maf.maf_contrib.NumObsMetric(night_col='night', nside=128, metric_name='NumObsMetric', **kwargs)

Bases: BaseMetric

Calculate the number of observations per data slice.

e.g. HealPix pixel when using HealPix slicer.

Parameters:

night_colstr

Name of the night column in the data; basically just need it to acccess the data for each visit. Default: ‘night’.

nsideint

HEALpix resolution parameter. Default: 128

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.