NYoungStarsMetric

class rubin_sim.maf.maf_contrib.NYoungStarsMetric(metric_name='young_stars', m5_col='fiveSigmaDepth', filter_col='filter', seeing_col='seeingFwhmGeom', mags={'g': 10.32, 'i': 7.97, 'r': 9.28}, snrs={'g': 5.0, 'i': 5.0, 'r': 5.0}, galb_limit=90.0, badval=0, return_distance=False, crowding_error=0.25, use_2D_extinction=False, **kwargs)

Bases: BaseMetric

Calculate the distance or number of stars with color uncertainty defined by mags/snrs.

Parameters:

metric_namestr, opt

Default ‘young_stars’.

m5_colstr, opt

The default column name for m5 information in the input data. Default fiveSigmaDepth.

filter_colstr, opt

The column name for the filter information. Default filter.

magsdict

The absolute magnitude of the object in question. Keys of filter name, values in mags. Default is for a 0.3 solar mass star at age = 100 Myr.

snrsdict

The SNR to demand for each filter.

galb_limitfloat, opt

The galactic latitude above which to return zero (degrees). Default 90.

badvalfloat, opt

The value to return when the metric value cannot be calculated. Default 0.

return_distancebool, opt

Whether the metric will return the maximum distance that can be reached for each slice_point, or the total number of stars down to mags/snrs.

crowding_error: float, opt

Crowding error that gets passed to CrowdingM5Metric. Default 0.25.

use_2D_extinction: Uses the 2D extinction map instead of the 3D one. Default False.

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.