NgalScaleMetric

class rubin_sim.maf.metrics.NgalScaleMetric(seeing_col='seeingFwhmEff', m5_col='fiveSigmaDepth', metric_name='NgalScale', filtername='i', a_max=0.2, m5min=26.0, filter_col='filter', **kwargs)

Bases: BaseMetric

Approximate number of galaxies, scaled by median seeing.

Parameters:

a_maxfloat (0.2)

The maximum dust extinction to allow. Anything with higher dust extinction is considered to have zero usable galaxies.

m5minfloat (26)

The minimum coadded 5-sigma depth to allow. Anything less is considered to have zero usable galaxies.

filterstr (“i”)

The filter to use. Any visits in other filters are ignored.

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.