Doc fixes

lsst · Dec 16, 2022 · 5775e2e · 5775e2e
1 parent a84a8b6
commit 5775e2e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 15 deletions.
diff --git a/python/lsst/analysis/tools/analysisPlots/analysisPlots.py b/python/lsst/analysis/tools/analysisPlots/analysisPlots.py
@@ -325,6 +325,11 @@ def setDefaults(self):
 
 
 class TargetRefCatDeltaSkyPlot(AnalysisPlot):
+    """Base class for plotting the RA/Dec distribution of stars, with the
+    difference between the RA or Dec of the target and reference catalog as
+    the color.
+    """
+
     parameterizedBand = Field[bool](
         doc="Does this AnalysisTool support band as a name parameter", default=True
     )
@@ -356,7 +361,7 @@ def setDefaults(self, coordinate):
 
         self.produce = SkyPlot()
         self.produce.plotTypes = ["stars"]
-        self.produce.plotName = f"astromDiff_{coordinate}"
+        self.produce.plotName = f"astromDiffSky_{coordinate}"
         self.produce.xAxisLabel = "R.A. (degrees)"
         self.produce.yAxisLabel = "Dec. (degrees)"
         self.produce.zAxisLabel = f"${coordinate}_{{target}} - {coordinate}_{{ref}}$ (marcsec)"
@@ -365,16 +370,16 @@ def setDefaults(self, coordinate):
 
 class TargetRefCatDeltaRASkyPlot(TargetRefCatDeltaSkyPlot):
     """Plot the difference in milliseconds between the RA of a target catalog
-    and a reference catalog
+    and a reference catalog as a function of RA and Dec.
     """
 
     def setDefaults(self):
         super().setDefaults(coordinate="RA")
 
 
 class TargetRefCatDeltaDecSkyPlot(TargetRefCatDeltaSkyPlot):
-    """Plot the difference in milliseconds between the RA of a target catalog
-    and a reference catalog
+    """Plot the difference in milliseconds between the Dec of a target catalog
+    and a reference catalog as a function of RA and Dec.
     """
 
     def setDefaults(self):

diff --git a/python/lsst/analysis/tools/tasks/refCatObjectAnalysis.py b/python/lsst/analysis/tools/tasks/refCatObjectAnalysis.py
@@ -51,13 +51,13 @@ def setDefaults(self):
         super().setDefaults()
 
         # set plots to run
-        self.plots.astromDiffRA = TargetRefCatDeltaRAScatterPlot()
-        self.plots.astromDiffRA.parameterizedBand = True
-        self.plots.astromDiffRA.applyContext(CoaddContext)
+        self.plots.astromDiffRAScatterPlot = TargetRefCatDeltaRAScatterPlot()
+        self.plots.astromDiffRAScatterPlot.parameterizedBand = True
+        self.plots.astromDiffRAScatterPlot.applyContext(CoaddContext)
 
-        self.plots.astromDiffDec = TargetRefCatDeltaDecScatterPlot()
-        self.plots.astromDiffDec.parameterizedBand = True
-        self.plots.astromDiffDec.applyContext(CoaddContext)
+        self.plots.astromDiffDecScatterPlot = TargetRefCatDeltaDecScatterPlot()
+        self.plots.astromDiffDecScatterPlot.parameterizedBand = True
+        self.plots.astromDiffDecScatterPlot.applyContext(CoaddContext)
 
         self.plots.astromDiffRASkyPlot = TargetRefCatDeltaRASkyPlot()
         self.plots.astromDiffRASkyPlot.parameterizedBand = True

diff --git a/python/lsst/analysis/tools/tasks/refCatSourceAnalysis.py b/python/lsst/analysis/tools/tasks/refCatSourceAnalysis.py
@@ -51,19 +51,20 @@ def setDefaults(self):
         super().setDefaults()
 
         # set plots to run
-        self.plots.astromDiffRA = TargetRefCatDeltaRAScatterPlot()
-        self.plots.astromDiffRA.applyContext(VisitContext)
+        self.plots.astromDiffRAScatterPlot = TargetRefCatDeltaRAScatterPlot()
+        self.plots.astromDiffRAScatterPlot.applyContext(VisitContext)
 
-        self.plots.astromDiffDec = TargetRefCatDeltaDecScatterPlot()
-        self.plots.astromDiffDec.applyContext(VisitContext)
+        self.plots.astromDiffDecScatterPlot = TargetRefCatDeltaDecScatterPlot()
+        self.plots.astromDiffDecScatterPlot.applyContext(VisitContext)
 
-        # set metrics to run - none so far
         self.plots.astromDiffRASkyPlot = TargetRefCatDeltaRASkyPlot()
         self.plots.astromDiffRASkyPlot.applyContext(VisitContext)
 
         self.plots.astromDiffDecSkyPlot = TargetRefCatDeltaDecSkyPlot()
         self.plots.astromDiffDecSkyPlot.applyContext(VisitContext)
 
+        # set metrics to run - none so far
+
 
 class RefCatSourceAnalysisTask(AnalysisPipelineTask):
     """Make plots and metrics using a table of objects matched to reference