NlcPointsMetric

class rubin_sim.maf.metrics.NlcPointsMetric(ndpmin=10, mags=21.0, m5_col='fiveSigmaDepth', filter_col='filter', metric_name='NlcPoints', maps=None, nside=128, **kwargs)

Bases: BaseMetric

Number of points in stellar light curves

Parameters:

ndpminint (10)

The number of points to demand on a lightcurve in a single filter to have that light curve qualify.

magsfloat (21)

The magnitude of our fiducial object (maybe make it a dict in the future to support arbitrary colors).

mapslist of map objects (None)

List of stellar density maps to use. Default of None loads Trilegal maps.

nsideint (128)

The nside is needed to make sure the loaded maps match the slicer nside.

Methods Summary

run(data_slice, slice_point)

Calculate metric values.

Methods Documentation

run(data_slice, slice_point)

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.