GalPlaneTimePerFilterMetric

class rubin_sim.maf.metrics.GalPlaneTimePerFilterMetric(science_map, mag_cuts=None, mjd_col='observationStartMJD', exp_time_col='visitExposureTime', filter_col='filter', m5_col='fiveSigmaDepth', filterlist=None, **kwargs)

Bases: BaseMetric

Evaluate the fraction of exposure time spent in each filter as a fraction of the total exposure time dedicated to that healpix in the weighted galactic plane priority maps.

Parameters:

scienceMapstr

Name of the priority footprint map key to use from the column headers contained in the priority_GalPlane_footprint_map_data tables.

magCutsdict of float, opt

Magnitudes to use as cutoffs for individual image depths. Default None uses a default set of values which correspond roughly to the 50th percentile.

mjd_colstr, opt

Name of the observation start MJD column. Default ‘observationStartMJD’.

exp_time_colstr, opt

Name of the exposure time column. Default ‘visitExposureTime’.

filter_colstr, opt

Name of the filter column. Default ‘filter’.

m5_colstr, opt

Name of the five-sigma depth column. Default ‘fiveSigmaDepth’.

filterlistlist of str, opt

The filters to consider from the priority map and observations. Default None uses u, g, r, i, z, and y.

metricNamestr, opt

Name for the metric. Default ‘GalPlaneFootprintMetric_{scienceMap}

Methods Summary

reduce_g(metricval)
reduce_i(metricval)
reduce_r(metricval)
reduce_u(metricval)
reduce_y(metricval)
reduce_z(metricval)
run(data_slice, slice_point)	Calculate the ratio of the actual on-sky exposure time per filter compared to the ideal on-sky exposure time per filter at this point on the sky across all filters.

Methods Documentation

reduce_g(metricval)

reduce_i(metricval)

reduce_r(metricval)

reduce_u(metricval)

reduce_y(metricval)

reduce_z(metricval)

run(data_slice, slice_point)

Calculate the ratio of the actual on-sky exposure time per filter compared to the ideal on-sky exposure time per filter at this point on the sky across all filters.