VisitGapMetric¶
- class rubin_sim.maf.metrics.VisitGapMetric(mjd_col='observationStartMJD', night_col='night', reduce_func=<function median>, metric_name='VisitGap', **kwargs)¶
Bases:
BaseMetric
Calculate the (reduce_func) of the gap between any consecutive observations, in hours, regardless of night boundaries.
Different from inter-night and intra-night gaps, between this is really just counting all of the times between consecutive observations (not time between nights or time within a night).
- Parameters:
- reduce_funcfunction, optional
Function that can operate on array-like structures. Typically numpy function. Default np.median.
Methods Summary
run
(data_slice[, slice_point])Calculate metric values.
Methods Documentation
- run(data_slice, slice_point=None)¶
Calculate metric values.
- Parameters:
- data_slice
numpy.ndarray
, (N,) Values passed to metric by the slicer, which the metric will use to calculate metric values at each slice_point.
- slice_point
dict
or None Dictionary of slice_point metadata passed to each metric. E.g. the ra/dec of the healpix pixel or opsim fieldId.
- data_slice
- Returns: