rubin-sim 2.6.1.dev2__py3-none-any.whl

rubin_sim/maf/batches/skycoverage.py

@@ -0,0 +1,155 @@
+"""Evaluate some bulk properties of the sky coverage"""
+
+__all__ = ("meanRADec", "eastWestBias")
+
+import numpy as np
+
+import rubin_sim.maf.metric_bundles as mb
+import rubin_sim.maf.metrics as metrics
+import rubin_sim.maf.slicers as slicers
+
+from .col_map_dict import col_map_dict
+
+
+def meanRADec(colmap=None, runName="opsim", extraSql=None, extraInfoLabel=None):
+    """Plot the range of RA/Dec as a function of night.
+
+    Parameters
+    ----------
+    colmap : `dict`, optional
+        A dictionary with a mapping of column names.
+    runName : `str`, optional
+        The name of the simulated survey.
+    extraSql : `str`, optional
+        Additional constraint to add to any sql constraints (e.g. 'night<365')
+    extraInfoLabel : `str`, optional
+        Additional info_label to add before any below (i.e. "WFD").
+
+    Returns
+    -------
+    metric_bundleDict : `dict` of `maf.MetricBundle`
+    """
+    if colmap is None:
+        colmap = col_map_dict()
+    bundleList = []
+
+    group = "RA Dec coverage"
+
+    subgroup = "All visits"
+    if extraInfoLabel is not None:
+        subgroup = extraInfoLabel
+
+    displayDict = {"group": group, "subgroup": subgroup, "order": 0}
+
+    ra_metrics = [
+        metrics.MeanAngleMetric(colmap["ra"]),
+        metrics.FullRangeAngleMetric(colmap["ra"]),
+    ]
+    dec_metrics = [
+        metrics.MeanMetric(colmap["dec"]),
+        metrics.MinMetric(colmap["dec"]),
+        metrics.MaxMetric(colmap["dec"]),
+    ]
+    for m in ra_metrics:
+        slicer = slicers.OneDSlicer(slice_col_name=colmap["night"], bin_size=1)
+        if not colmap["raDecDeg"]:
+            plotDict = {"y_min": np.radians(-5), "y_max": np.radians(365)}
+        else:
+            plotDict = {"y_min": -5, "y_max": 365}
+        bundle = mb.MetricBundle(
+            m,
+            slicer,
+            extraSql,
+            info_label=extraInfoLabel,
+            display_dict=displayDict,
+            plot_dict=plotDict,
+        )
+        bundleList.append(bundle)
+
+    for m in dec_metrics:
+        slicer = slicers.OneDSlicer(slice_col_name=colmap["night"], bin_size=1)
+        bundle = mb.MetricBundle(m, slicer, extraSql, info_label=extraInfoLabel, display_dict=displayDict)
+        bundleList.append(bundle)
+
+    # Set the run_name for all bundles and return the bundleDict.
+    for b in bundleList:
+        b.set_run_name(runName)
+    return mb.make_bundles_dict_from_list(bundleList)
+
+
+def eastWestBias(colmap=None, runName="opsim", extraSql=None, extraInfoLabel=None):
+    """Plot the number of observations to the east vs to the west, per night.
+
+    Parameters
+    ----------
+    colmap : `dict`, optional
+        A dictionary with a mapping of column names.
+    runName : `str`, optional
+        The name of the simulated survey.
+    extraSql : `str`, optional
+        Additional constraint to add to any sql constraints (e.g. 'night<365')
+    extraInfoLabel : `str`, optional
+        Additional info_label to add before any below (i.e. "WFD").
+
+    Returns
+    -------
+    metric_bundleDict : `dict` of `maf.MetricBundle`
+    """
+    if colmap is None:
+        colmap = col_map_dict()
+    bundleList = []
+
+    group = "East vs West"
+
+    subgroup = "All visits"
+    if extraInfoLabel is not None:
+        subgroup = extraInfoLabel
+
+    displayDict = {"group": group, "subgroup": subgroup, "order": 0}
+
+    eastvswest = 180
+    if not colmap["raDecDeg"]:
+        eastvswest = np.radians(eastvswest)
+
+    displayDict["caption"] = "Number of visits per night that occur with azimuth <= 180."
+    if extraSql is not None:
+        displayDict["caption"] += " With additional sql constraint %s." % extraSql
+    metric = metrics.CountMetric(colmap["night"], metric_name="Nvisits East")
+    slicer = slicers.OneDSlicer(slice_col_name=colmap["night"], bin_size=1)
+    sql = "%s <= %f" % (colmap["az"], eastvswest)
+    if extraSql is not None:
+        sql = "(%s) and (%s)" % (sql, extraSql)
+    plotDict = {"color": "orange", "label": "East"}
+    bundle = mb.MetricBundle(
+        metric,
+        slicer,
+        sql,
+        info_label=extraInfoLabel,
+        display_dict=displayDict,
+        plot_dict=plotDict,
+    )
+    bundleList.append(bundle)
+
+    displayDict["caption"] = "Number of visits per night that occur with azimuth > 180."
+    if extraSql is not None:
+        displayDict["caption"] += " With additional sql constraint %s." % extraSql
+    metric = metrics.CountMetric(colmap["night"], metric_name="Nvisits West")
+    slicer = slicers.OneDSlicer(slice_col_name=colmap["night"], bin_size=1)
+    sql = "%s > %f" % (colmap["az"], eastvswest)
+    if extraSql is not None:
+        sql = "(%s) and (%s)" % (sql, extraSql)
+    plotDict = {"color": "blue", "label": "West"}
+    bundle = mb.MetricBundle(
+        metric,
+        slicer,
+        sql,
+        info_label=extraInfoLabel,
+        display_dict=displayDict,
+        plot_dict=plotDict,
+    )
+    bundleList.append(bundle)
+
+    # Set the run_name for all bundles and return the bundleDict.
+    for b in bundleList:
+        b.set_run_name(runName)
+    return mb.make_bundles_dict_from_list(bundleList)

rubin_sim/maf/batches/slew_batch.py

@@ -0,0 +1,146 @@
+"""Sets of slew metrics."""
+
+__all__ = ("slewBasics",)
+
+import numpy as np
+
+import rubin_sim.maf.metric_bundles as mb
+import rubin_sim.maf.metrics as metrics
+import rubin_sim.maf.slicers as slicers
+
+from .col_map_dict import col_map_dict
+from .common import standard_metrics
+
+
+def slewBasics(colmap=None, run_name="opsim", sql_constraint=None):
+    """Generate a simple set of statistics about the slew times and distances.
+
+    Parameters
+    ----------
+    colmap : `dict` or None, optional
+        A dictionary with a mapping of column names.
+    runName : `str`, optional
+        The name of the simulated survey.
+    sqlConstraint : `str` or None, optional
+        SQL constraint to add to metrics.
+
+    Returns
+    -------
+    metric_bundleDict : `dict` of `maf.MetricBundle`
+    """
+
+    if colmap is None:
+        colmap = col_map_dict()
+
+    bundleList = []
+
+    # Calculate basic stats on slew times. (mean/median/min/max + total).
+    slicer = slicers.UniSlicer()
+
+    info_label = "All visits"
+    if sql_constraint is not None and len(sql_constraint) > 0:
+        info_label = "%s" % (sql_constraint)
+    displayDict = {
+        "group": "Slew",
+        "subgroup": "Slew Basics",
+        "order": -1,
+        "caption": None,
+    }
+    # Add total number of slews.
+    metric = metrics.CountMetric(colmap["slewtime"], metric_name="Slew Count")
+    displayDict["caption"] = "Total number of slews recorded."
+    displayDict["order"] += 1
+    bundle = mb.MetricBundle(metric, slicer, sql_constraint, info_label=info_label, display_dict=displayDict)
+    bundleList.append(bundle)
+    for metric in standard_metrics(colmap["slewtime"]):
+        displayDict["caption"] = "%s in seconds." % (metric.name)
+        displayDict["order"] += 1
+        bundle = mb.MetricBundle(
+            metric,
+            slicer,
+            sql_constraint,
+            info_label=info_label,
+            display_dict=displayDict,
+        )
+        bundleList.append(bundle)
+
+    # Slew Time histogram.
+    slicer = slicers.OneDSlicer(slice_col_name=colmap["slewtime"], bin_size=2)
+    metric = metrics.CountMetric(col=colmap["slewtime"], metric_name="Slew Time Histogram")
+    info_label = "All visits"
+    plotDict = {"log_scale": True, "ylabel": "Count"}
+    displayDict["caption"] = "Histogram of slew times (seconds) for all visits."
+    displayDict["order"] += 1
+    bundle = mb.MetricBundle(
+        metric,
+        slicer,
+        sql_constraint,
+        info_label=info_label,
+        plot_dict=plotDict,
+        display_dict=displayDict,
+    )
+    bundleList.append(bundle)
+    # Zoom in on slew time histogram near 0.
+    slicer = slicers.OneDSlicer(slice_col_name=colmap["slewtime"], bin_size=0.2, bin_min=0, bin_max=20)
+    metric = metrics.CountMetric(col=colmap["slewtime"], metric_name="Zoom Slew Time Histogram")
+    info_label = "All visits"
+    plotDict = {"log_scale": True, "ylabel": "Count"}
+    displayDict["caption"] = "Histogram of slew times (seconds) for all visits (zoom)."
+    displayDict["order"] += 1
+    bundle = mb.MetricBundle(
+        metric,
+        slicer,
+        sql_constraint,
+        info_label=info_label,
+        plot_dict=plotDict,
+        display_dict=displayDict,
+    )
+    bundleList.append(bundle)
+
+    # Slew distance histogram, if available.
+    if colmap["slewdist"] is not None:
+        bin_size = 2.0
+        if not colmap["raDecDeg"]:
+            bin_size = np.radians(bin_size)
+        slicer = slicers.OneDSlicer(slice_col_name=colmap["slewdist"], bin_size=bin_size)
+        metric = metrics.CountMetric(col=colmap["slewdist"], metric_name="Slew Distance Histogram")
+        plotDict = {"log_scale": True, "ylabel": "Count"}
+        displayDict["caption"] = "Histogram of slew distances (angle) for all visits."
+        displayDict["order"] += 1
+        bundle = mb.MetricBundle(
+            metric,
+            slicer,
+            sql_constraint,
+            info_label=info_label,
+            plot_dict=plotDict,
+            display_dict=displayDict,
+        )
+        bundleList.append(bundle)
+        # Zoom on slew distance histogram.
+        bin_max = 20.0
+        if not colmap["raDecDeg"]:
+            bin_max = np.radians(bin_max)
+        slicer = slicers.OneDSlicer(
+            slice_col_name=colmap["slewdist"],
+            bin_size=bin_size / 10.0,
+            bin_min=0,
+            bin_max=bin_max,
+        )
+        metric = metrics.CountMetric(col=colmap["slewdist"], metric_name="Zoom Slew Distance Histogram")
+        plotDict = {"log_scale": True, "ylabel": "Count"}
+        displayDict["caption"] = "Histogram of slew distances (angle) for all visits."
+        displayDict["order"] += 1
+        bundle = mb.MetricBundle(
+            metric,
+            slicer,
+            sql_constraint,
+            info_label=info_label,
+            plot_dict=plotDict,
+            display_dict=displayDict,
+        )
+        bundleList.append(bundle)
+
+    # Set the run_name for all bundles and return the bundleDict.
+    for b in bundleList:
+        b.set_run_name(run_name)
+    return mb.make_bundles_dict_from_list(bundleList)