DM-33960: Add astrometry residuals with refcat plots

pipelines/LSSTCam-imSim/analysis_drp_plots.in

@@ -3,4 +3,6 @@ imports:
   - "$ANALYSIS_DRP_DIR/pipelines/generic_visit_plots.yaml"
 
 description: |
-  analysis drp plot pipeline specialized for imsim
+  analysis drp plot pipeline specialized for imsim
+
+instrument: lsst.obs.lsst.LsstCamImSim

pipelines/LSSTCam-imSim/dc2_coadd_plots.in

@@ -5,3 +5,5 @@ imports:
 
 description: |
   Coadd analysis drp plots specialized for LSSTCam
+
+instrument: lsst.obs.lsst.LsstCamImSim

pipelines/coaddQAPlots.yaml

@@ -411,3 +411,77 @@ tasks:
       selectorActions.SnSelector.bands: ["g", "r", "i"]
       python: >
        from lsst.analysis.drp.dataSelectors import FlagSelector, CoaddPlotFlagSelector, SnSelector
+
+  plot_astromRefCat_sky_tract_dRA:
+    class: lsst.analysis.drp.skyPlot.SkyPlotTask
+    config:
+      connections.catPlot: objectTable_tract_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_sky_ra_coadd_i
+      axisActions.zAction: AstromDiff
+      axisActions.zAction.col1: "coord_ra_target"
+      axisActions.zAction.col2: "coord_ra_ref"
+      axisActions.xAction.column: "coord_ra_ref"
+      axisActions.yAction.column: "coord_dec_ref"
+      selectorActions.flagSelector: CoaddPlotFlagSelector
+      selectorActions.flagSelector.bands: ["i"]
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: "i"
+      axisLabels: {"x": "R.A. (Degrees)", "y": "Dec. (Degrees)", "z": "$RA_{target} - RA_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import CoaddPlotFlagSelector, StarIdentifier, SnSelector
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_sky_tract_dDec:
+    class: lsst.analysis.drp.skyPlot.SkyPlotTask
+    config:
+      connections.catPlot: objectTable_tract_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_sky_dec_coadd_i
+      axisActions.zAction: AstromDiff
+      axisActions.zAction.col1: "coord_dec_target"
+      axisActions.zAction.col2: "coord_dec_ref"
+      axisActions.xAction.column: "coord_ra_ref"
+      axisActions.yAction.column: "coord_dec_ref"
+      selectorActions.flagSelector: CoaddPlotFlagSelector
+      selectorActions.flagSelector.bands: ["i"]
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: "i"
+      axisLabels: {"x": "R.A. (Degrees)", "y": "Dec. (Degrees)", "z": "$Dec_{target} - Dec_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import CoaddPlotFlagSelector, StarIdentifier, SnSelector
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_scatter_tract_dRA:
+    class: lsst.analysis.drp.scatterPlot.ScatterPlotWithTwoHistsTask
+    config:
+      connections.catPlot: objectTable_tract_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_scatter_ra_coadd_i
+      axisActions.yAction: AstromDiff
+      axisActions.yAction.col1: "coord_ra_target"
+      axisActions.yAction.col2: "coord_ra_ref"
+      selectorActions.flagSelector: CoaddPlotFlagSelector
+      selectorActions.flagSelector.bands: ["i"]
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: "i"
+      axisLabels: {"x": "PSF Magnitude (mag)", "mag": "PSF Magnitude (mag)",
+                   "y": "$RA_{target} - RA_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import CoaddPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_scatter_tract_dDec:
+    class: lsst.analysis.drp.scatterPlot.ScatterPlotWithTwoHistsTask
+    config:
+      connections.catPlot: objectTable_tract_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_scatter_dec_coadd_i
+      axisActions.yAction: AstromDiff
+      axisActions.yAction.col1: "coord_dec_target"
+      axisActions.yAction.col2: "coord_dec_ref"
+      selectorActions.flagSelector: CoaddPlotFlagSelector
+      selectorActions.flagSelector.bands: ["i"]
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: "i"
+      axisLabels: {"x": "PSF Magnitude (mag)", "mag": "PSF Magnitude (mag)",
+                   "y": "$Dec_{target} - Dec_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import CoaddPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff

pipelines/generic_coadd_plots.in

@@ -2,6 +2,7 @@ imports:
   - "$ANALYSIS_DRP_DIR/pipelines/coaddQAPlots.yaml"
   - "$ANALYSIS_DRP_DIR/pipelines/coaddQAEllipPlots.yaml"
   - "$ANALYSIS_DRP_DIR/pipelines/stellarLocusPlots.yaml"
+  - "$ANALYSIS_DRP_DIR/pipelines/matchCoaddCatalogs.yaml"
 
 description: |
   Coadd level analysis drp plots

pipelines/generic_visit_plots.in

@@ -1,6 +1,7 @@
 imports:
   - "$ANALYSIS_DRP_DIR/pipelines/visitQAEllipPlots.yaml"
   - "$ANALYSIS_DRP_DIR/pipelines/visitQAPlots.yaml"
+  - "$ANALYSIS_DRP_DIR/pipelines/matchVisitCatalogs.yaml"
 
 description: |
   Visit level analysis drp plots

pipelines/matchCoaddCatalogs.yaml

@@ -0,0 +1,7 @@
+description: |
+    Match coadd level catalogs with reference catalogs for QA. 
+parameters:
+  band: i
+tasks:
+  match_astromRefCat_objectTable:
+    class: lsst.analysis.drp.catalogMatch.CatalogMatchTask

pipelines/matchVisitCatalogs.yaml

@@ -0,0 +1,15 @@
+description: |
+    Match visit level catalogs with reference catalogs for QA.
+    For visit level tasks the bands needs to be set to [""] to allow the code to be reused between
+    the coadd level tables, which have band_ prepended to their column names, and the visit level
+    tables which do not.
+parameters:
+  band: i
+tasks:
+  match_astromRefCat_visit:
+    class: lsst.analysis.drp.catalogMatch.CatalogMatchVisitTask
+    config:
+      selectorActions.flagSelector: VisitPlotFlagSelector
+      sourceSelectorActions.sourceSelector.band: ""
+      python: |
+        from lsst.analysis.drp.dataSelectors import VisitPlotFlagSelector

pipelines/visitQAPlots.yaml

@@ -314,3 +314,74 @@ tasks:
       axisLabels: {"x": "R.A. (Degrees)", "y": "Dec. (Degrees)", "z": "Sky Object Flux (nJy)"}
       python: |
        from lsst.analysis.drp.dataSelectors import (FlagSelector)
+
+  plot_astromRefCat_sky_visit_dRA:
+    class: lsst.analysis.drp.skyPlotVisit.SkyPlotVisitTask
+    config:
+      connections.catPlot: sourceTable_visit_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_sky_ra_visit
+      axisActions.zAction: AstromDiff
+      axisActions.zAction.col1: "coord_ra_target"
+      axisActions.zAction.col2: "coord_ra_ref"
+      axisActions.xAction.column: "coord_ra_ref"
+      axisActions.yAction.column: "coord_dec_ref"
+      selectorActions.flagSelector: VisitPlotFlagSelector
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: ""
+      axisLabels: {"x": "R.A. (Degrees)", "y": "Dec. (Degrees)", "z": "$RA_{target} - RA_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import VisitPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_sky_visit_dDec:
+    class: lsst.analysis.drp.skyPlotVisit.SkyPlotVisitTask
+    config:
+      connections.catPlot: sourceTable_visit_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_sky_dec_visit
+      axisActions.zAction: AstromDiff
+      axisActions.zAction.col1: "coord_dec_target"
+      axisActions.zAction.col2: "coord_dec_ref"
+      axisActions.xAction.column: "coord_ra_ref"
+      axisActions.yAction.column: "coord_dec_ref"
+      selectorActions.flagSelector: VisitPlotFlagSelector
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: ""
+      axisLabels: {"x": "R.A. (Degrees)", "y": "Dec. (Degrees)",
+                   "z": "$Dec_{target} - Dec_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import VisitPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_scatter_visit_dRA:
+    class: lsst.analysis.drp.scatterPlotVisit.ScatterPlotVisitTask
+    config:
+      connections.catPlot: sourceTable_visit_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_scatter_ra_visit
+      axisActions.yAction: AstromDiff
+      axisActions.yAction.col1: "coord_ra_target"
+      axisActions.yAction.col2: "coord_ra_ref"
+      selectorActions.flagSelector: VisitPlotFlagSelector
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: ""
+      axisLabels: {"x": "PSF Magnitude (mag)", "mag": "PSF Magnitude (mag)",
+                   "y": "$RA_{target} - RA_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import VisitPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff
+
+  plot_astromRefCat_scatter_visit_dDec:
+    class: lsst.analysis.drp.scatterPlotVisit.ScatterPlotVisitTask
+    config:
+      connections.catPlot: sourceTable_visit_astrometryRefCat_match
+      connections.plotName: astromRefCatResiduals_scatter_dec_visit
+      axisActions.yAction: AstromDiff
+      axisActions.yAction.col1: "coord_dec_target"
+      axisActions.yAction.col2: "coord_dec_ref"
+      selectorActions.flagSelector: VisitPlotFlagSelector
+      sourceSelectorActions.sourceSelector: StarIdentifier
+      sourceSelectorActions.sourceSelector.band: ""
+      axisLabels: {"x": "PSF Magnitude (mag)", "mag": "PSF Magnitude (mag)",
+                   "y": "$Dec_{target} - Dec_{ref}$ (marcsec)"}
+      python: |
+        from lsst.analysis.drp.dataSelectors import VisitPlotFlagSelector, StarIdentifier
+        from lsst.analysis.drp.calcFunctors import AstromDiff

python/lsst/analysis/drp/calcFunctors.py

@@ -1029,3 +1029,49 @@ def __call__(self, df):
         pull = color_diff/np.sqrt(err1_sq + err2_sq)
 
         return pull
+
+
+class AstromDiff(MultiColumnAction):
+    """Calculate the difference between two columns, assuming their units
+    are degrees, and convert the difference to arcseconds.
+
+    Parameters
+    ----------
+    df : `pandas.core.frame.DataFrame`
+        The catalog to calculate the position difference from.
+
+    Returns
+    -------
+    The difference.
+
+    Notes
+    -----
+    The columns need to be in units (specifiable in
+    the radecUnits1 and 2 config options) that can be converted
+    to arcseconds. This action doesn't have any calibration
+    information and assumes that the positions are already
+    calibrated.
+    """
+
+    col1 = Field(doc="Column to subtract from", dtype=str)
+    radecUnits1 = Field(doc="Units for col1", dtype=str, default="degree")
+    col2 = Field(doc="Column to subtract", dtype=str)
+    radecUnits2 = Field(doc="Units for col2", dtype=str, default="degree")
+    returnMilliArcsecs = Field(doc="Use marcseconds or not?", dtype=bool, default=True)
+
+    @property
+    def columns(self):
+        return (self.col1, self.col2)
+
+    def __call__(self, df):
+        angle1 = df[self.col1].values * u.Unit(self.radecUnits1)
+
+        angle2 = df[self.col2].values * u.Unit(self.radecUnits2)
+
+        angleDiff = angle1 - angle2
+
+        if self.returnMilliArcsecs:
+            angleDiffValue = angleDiff.to(u.arcsec) * 1000
+        else:
+            angleDiffValue = angleDiff.value
+        return angleDiffValue