GalaxyCountsMetricExtended

class rubin_sim.maf.maf_contrib.GalaxyCountsMetricExtended(m5_col='fiveSigmaDepth', filter_col='filter', nside=128, metric_name='GalaxyCountsMetricExtended', units='Galaxy Counts', upper_mag_limit=32.0, include_dust_extinction=True, filter_band='i', redshift_bin='all', cfht_ls_counts=False, normalized_mock_catalog_counts=True, **kwargs)

Bases: BaseMetric

Estimate galaxy counts per HEALpix pixel. Accomodates for dust extinction, magnitude cuts, and specification of the galaxy LF to specific redshift bin to consider.

Dependency (aside from MAF): constantsForPipeline.py

Parameters:

m5_colstr

name of column for depth in the data. Default: ‘fiveSigmaDepth’

nside: `int`, opt

HEALpix resolution parameter. Default: 128

upper_mag_limitfloat

upper limit on magnitude when calculating the galaxy counts. Default: 32.0

include_dust_extinctionbool

set to False if do not want to include dust extinction. Default: True

filter_bandstr, opt

any one of ‘u’, ‘g’, ‘r’, ‘i’, ‘z’, ‘y’. Default: ‘i’

redshift_binstr, opt

options include ‘0.<z<0.15’, ‘0.15<z<0.37’, ‘0.37<z<0.66, ‘0.66<z<1.0’, ‘1.0<z<1.5’, ‘1.5<z<2.0’, ‘2.0<z<2.5’, ‘2.5<z<3.0’,’3.0<z<3.5’, ‘3.5<z<4.0’, ‘all’ for no redshift restriction (i.e. 0.<z<4.0) Default: ‘all’

cfht_ls_counts: `bool`, opt

set to True if want to calculate the total galaxy counts from CFHTLS powerlaw from LSST Science Book. Must be run with redshift_bin= ‘all’ Default: False

normalized_mock_catalog_counts: `bool`, opt

set to False if want the raw/un-normalized galaxy counts from mock catalogs. Default: True

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.