move from note to scheduler_note in opsim db schema where applicable

lsst · Sep 19, 2024 · 9b8068d · 9b8068d
1 parent 38c18ce
commit 9b8068d
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 18 deletions.
diff --git a/schedview/compute/scheduler.py b/schedview/compute/scheduler.py
@@ -55,6 +55,8 @@ def _make_observation_from_record(record):
     observation["moonAlt"] = np.radians(record["moonAlt"])
     observation["sunAlt"] = np.radians(record["sunAlt"])
     observation["note"] = record["note"]
+    if "scheduler_note" in record:
+        observation["scheduler_note"] = record["scheduler_note"]
     observation["field_id"] = record["fieldId"]
     observation["survey_id"] = record["proposalId"]
     observation["block_id"] = record["block_id"]

diff --git a/schedview/data/sample_prenight_custom_hvplots.json b/schedview/data/sample_prenight_custom_hvplots.json
@@ -2,7 +2,7 @@
     {
         "name": "Airmass histogram",
         "settings": {
-            "by": "note",
+            "by": "scheduler_note",
             "kind": "hist",
             "y": "airmass",
             "bins": 15,
@@ -15,7 +15,7 @@
     {
         "name": "Slew time histogram",
         "settings": {
-            "by": "note",
+            "by": "scheduler_note",
             "kind": "hist",
             "y": "slewTime",
             "bins": 15,
@@ -28,7 +28,7 @@
     {
         "name": "Airmass vs. H.A.",
         "settings": {
-            "by": "note",
+            "by": "scheduler_note",
             "kind": "scatter",
             "x": "HA",
             "y": "airmass",
@@ -44,7 +44,7 @@
                 "moonAlt",
                 "moonDistance",
                 "moonPhase",
-                "note"
+                "scheduler_note"
             ],
             "height": 512
         }
@@ -62,7 +62,7 @@
                 "sunAlt",
                 "moonAlt",
                 "moonPhase",
-                "note"
+                "scheduler_note"
             ],
             "height": 512
         }

diff --git a/schedview/plot/nightly.py b/schedview/plot/nightly.py
@@ -162,6 +162,7 @@ def plot_alt_vs_time(
     event_labels=DEFAULT_EVENT_LABELS,
     event_colors=DEFAULT_EVENT_COLORS,
     figure=None,
+    note_column=None,
 ):
     """Plot airmass vs. time for a set of visits
 
@@ -181,12 +182,24 @@ def plot_alt_vs_time(
         Default is `DEFAULT_EVENT_COLORS`.
     figure : `bokeh.plotting.Figure`
         Bokeh figure object to plot on.  If None, a new figure will be created.
+    note_column : `str` or None
+        The column to use as the note to map to color.
+        Defaults to None, which defaults `scheduler_note` if it is present
+        in the visit datasource, otherwise `note`.
 
     Returns
     -------
     fig : `bokeh.plotting.Figure`
         Bokeh figure object
     """
+
+    if note_column is None:
+        if isinstance(visits, bokeh.models.ColumnDataSource):
+            scheduler_note_present = "scheduler_note" in visits.data
+        else:
+            scheduler_note_present = "scheduler_note" in visits
+        note_column = "scheduler_note" if scheduler_note_present else "note"
+
     for time_column in "start_date", "observationStartDatetime64":
         if isinstance(visits, bokeh.models.ColumnDataSource):
             if time_column in visits.data:
@@ -211,17 +224,17 @@ def plot_alt_vs_time(
     else:
         visits_ds = bokeh.models.ColumnDataSource(visits)
 
-    note_values = np.unique(visits_ds.data["note"])
+    note_values = np.unique(visits_ds.data[note_column])
     too_many_note_values = len(note_values) > len(colorcet.palette["glasbey"])
 
     if not too_many_note_values:
         note_color_mapper = bokeh.models.CategoricalColorMapper(
-            factors=note_values, palette=colorcet.palette["glasbey"][: len(note_values)], name="note"
+            factors=note_values, palette=colorcet.palette["glasbey"][: len(note_values)], name=note_column
         )
 
         if "note_and_filter" not in visits_ds.column_names:
             note_and_filter = tuple(
-                [f"{n} in {f}" for n, f in zip(visits_ds.data["note"], visits_ds.data["filter"])]
+                [f"{n} in {f}" for n, f in zip(visits_ds.data[note_column], visits_ds.data["filter"])]
             )
             visits_ds.add(note_and_filter, "note_and_filter")
 
@@ -247,7 +260,7 @@ def plot_alt_vs_time(
             time_column,
             "altitude",
             source=visits_ds,
-            color={"field": "note", "transform": note_color_mapper},
+            color={"field": note_column, "transform": note_color_mapper},
             marker={"field": "filter", "transform": filter_marker_mapper},
             size=5,
             legend_field="note_and_filter",
@@ -366,7 +379,7 @@ def _add_az_graticules(fig, transform, min_alt=0, min_az=0, max_az=360, az_step=
             )
 
 
-def plot_polar_alt_az(visits, band_shapes=BAND_SHAPES, figure=None, legend=True):
+def plot_polar_alt_az(visits, band_shapes=BAND_SHAPES, figure=None, legend=True, note_column=None):
     """Plot airmass vs. time for a set of visits
 
     Parameters
@@ -387,6 +400,12 @@ def plot_polar_alt_az(visits, band_shapes=BAND_SHAPES, figure=None, legend=True)
     fig : `bokeh.plotting.Figure`
         Bokeh figure object
     """
+    if note_column is None:
+        if isinstance(visits, bokeh.models.ColumnDataSource):
+            scheduler_note_present = "scheduler_note" in visits.data
+        else:
+            scheduler_note_present = "scheduler_note" in visits
+        note_column = "scheduler_note" if scheduler_note_present else "note"
 
     if figure is None:
         fig = bokeh.plotting.figure(
@@ -416,17 +435,17 @@ def plot_polar_alt_az(visits, band_shapes=BAND_SHAPES, figure=None, legend=True)
     if "zd" not in visits_ds.column_names:
         visits_ds.add(90 - np.array(visits_ds.data["altitude"]), "zd")
 
-    note_values = np.unique(visits_ds.data["note"])
+    note_values = np.unique(visits_ds.data[note_column])
     too_many_note_values = len(note_values) > len(colorcet.palette["glasbey"])
 
     if not too_many_note_values:
         note_color_mapper = bokeh.models.CategoricalColorMapper(
-            factors=note_values, palette=colorcet.palette["glasbey"][: len(note_values)], name="note"
+            factors=note_values, palette=colorcet.palette["glasbey"][: len(note_values)], name=note_column
         )
 
         if "note_and_filter" not in visits_ds.column_names:
             note_and_filter = tuple(
-                [f"{n} in {f}" for n, f in zip(visits_ds.data["note"], visits_ds.data["filter"])]
+                [f"{n} in {f}" for n, f in zip(visits_ds.data[note_column], visits_ds.data["filter"])]
             )
             visits_ds.add(note_and_filter, "note_and_filter")
 
@@ -456,7 +475,7 @@ def plot_polar_alt_az(visits, band_shapes=BAND_SHAPES, figure=None, legend=True)
             polar_transform.y,
             polar_transform.x,
             source=visits_ds,
-            color={"field": "note", "transform": note_color_mapper},
+            color={"field": note_column, "transform": note_color_mapper},
             marker={"field": "filter", "transform": filter_marker_mapper},
             size=5,
             legend_field="note_and_filter",

diff --git a/schedview/plot/visitmap.py b/schedview/plot/visitmap.py
@@ -28,7 +28,7 @@
 VISIT_TOOLTIPS = (
     "@observationId: @start_date{%F %T} UTC (mjd=@observationStartMJD{00000.0000}, "
     + "LST=@observationStartLST\u00b0), band=@filter, RA=@fieldRA\u00b0, Decl=@fieldDec\u00b0, "
-    + "PA=@paraAngle\u00b0, Az=@azimuth\u00b0, Alt=@altitude\u00b0, @note"
+    + "PA=@paraAngle\u00b0, Az=@azimuth\u00b0, Alt=@altitude\u00b0"
 )
 VISIT_COLUMNS = [
     "observationId",
@@ -42,7 +42,6 @@
     "paraAngle",
     "azimuth",
     "altitude",
-    "note",
 ]
 
 NSIDE_LOW = 8

diff --git a/schedview/plot/visits.py b/schedview/plot/visits.py
@@ -29,7 +29,7 @@ def visits_tooltips(weather: bool = False) -> list:
             + ")",
         ),
         ("flush by mjd", "@flush_by_mjd{00000.00}"),
-        ("Note", "@note"),
+        ("Scheduler note", "@scheduler_note"),
         ("Filter", "@filter"),
         (
             "Field coordinates",
@@ -104,7 +104,9 @@ def plot_visits(visits):
     figure : `hvplot.ui.hvDataFrameExplorer`
         The figure itself.
     """
-    visit_explorer = hvplot.explorer(visits, kind="scatter", x="start_date", y="airmass", by=["note"])
+    visit_explorer = hvplot.explorer(
+        visits, kind="scatter", x="start_date", y="airmass", by=["scheduler_note"]
+    )
     return visit_explorer