HistogramMetric

class rubin_sim.maf.metrics.HistogramMetric(bins=None, bin_col='night', col='night', units='Count', statistic='count', metric_dtype=<class 'float'>, **kwargs)

Bases: VectorMetric

A wrapper to stats.binned_statistic

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.