GalPlaneSeasonGapsTimescaleMetric

class rubin_sim.maf.metrics.GalPlaneSeasonGapsTimescaleMetric(science_map, tau_var=None, mag_limit=22.0, expected_season_gap=145, mjd_col='observationStartMJD', m5_col='fiveSigmaDepth', **kwargs)

Bases: BaseMetric

Metric to evaluate the gap between sequential seasonal gaps in observations in a lightcurve relative to the scientifically desired sampling interval.

Parameters:

science_mapstr

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

tau_varnp.ndarray or list of float, opt

Timescales of variability for various classes of time variability. Default (None), uses TAU_OBS * 5. In general, this should be left as the default and consistent across all galactic-plane oriented metrics.

mag_limitfloat, opt

Magnitude limit to use as a cutoff for various observations. Default 22.0.

expected_season_gapfloat, opt

The typical season gap expected for a galactic plane field in days. The default, 145 days, is typical for a bulge field.

mjd_colstr, opt

The name of the observation start MJD column. Default ‘observationStartMJD’.

m5_col`str’, opt

The name of the five sigma depth column. Default ‘fiveSigmaDepth’.

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.