DM-39683: Break faro task up into visit, matched, and tract-based subsets

doc/conf.py

@@ -7,7 +7,6 @@
 
 from documenteer.conf.pipelinespkg import *
 
-
 project = "drp_pipe"
 html_theme_options["logotext"] = project
 html_title = project

pipelines/HSC/DRP-Prod.yaml

@@ -3,7 +3,9 @@ instrument: lsst.obs.subaru.HyperSuprimeCam
 imports:
   - location: "$DRP_PIPE_DIR/pipelines/_ingredients/HSC/DRP.yaml"
     exclude:
-      - faro_all
+      - faro_visit
+      - faro_matched
+      - faro_tract
 tasks:
   fgcmFitCycle:
     class: lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask

pipelines/HSC/DRP-ci_hsc.yaml

@@ -7,7 +7,9 @@ imports:
       # there isn't enough data.
       - fgcm
       - gbdesAstrometricFit
-      - faro_all
+      - faro_visit
+      - faro_matched
+      - faro_tract
       # Some of these plots fail with ci_hsc data
       # - analyzeObjectTableCore
       # - refCatObjectTract

pipelines/_ingredients/HSC/DRP+fakes.yaml

@@ -45,7 +45,9 @@ imports:
     - analyzeObjectTableSurveyCore
     - catalogMatchTract
     - refCatObjectTract
-    - faro_all
+    - faro_visit
+    - faro_matched
+    - faro_tract
 tasks:
   singleFrameWithFakes:
     class: lsst.pipe.tasks.processCcdWithFakes.ProcessCcdWithFakesTask

pipelines/_ingredients/HSC/DRP.yaml

@@ -17,13 +17,17 @@ tasks:
     config:
       doMultipleCycles: true
 subsets:
-  faro_all:
+  faro_visit:
     subset:
-      # visit-level on single-frame products
       - nsrcMeasVisit
       - TE3
       - TE4
-      # tract-level, matched-visit on single-frame products
+    description: |
+      Set of visit-level faro metrics. These tasks run on single-frame products and
+      require Calibrated Source Tables, which are available after
+      consolidateSourceTable (step6) is run.
+  faro_matched:
+    subset:
       - matchCatalogsTract
       - matchCatalogsPatch
       - matchCatalogsPatchMultiBand
@@ -54,17 +58,17 @@ subsets:
       - psfPhotRepStar2
       - psfPhotRepStar3
       - psfPhotRepStar4
-      # tract-level on coadd products
+    description: |
+      Set of tract-level, matched-visit faro metrics. These tasks run on single-frame
+      products and require Calibrated Source Tables, which are available after
+      consolidateSourceTable (step6) is run.
+  faro_tract:
+    subset:
       - TE1
       - TE2
       - wPerp
       - skyObjectMean
       - skyObjectStd
     description: |
-      Set of tasks for calculation of metrics via faro.
-      These tasks are a mix of visit- and tract-level and must be run globally
-      for RC2.
-      Tasks that require single-frame products use Calibrated Source Tables,
-      which are available after consolidateSourceTable (step6) is run.
-      Tasks that require coadd products use Object Tables which are available
-      after consolidateObjectTable (step3) is run.
+      Set of tract-level faro metrics to be run on coadd products. These use Object
+      Tables which are available after consolidateObjectTable (step3) is run.

pipelines/_ingredients/LSSTCam-imSim/DRP.yaml

@@ -245,13 +245,17 @@ subsets:
 
       Includes extended-level diff_matched_analysis metrics, which are
       considered core for DC2 as they can't be run on other datasets yet.
-  faro_all:
+  faro_visit:
     subset:
-      # visit-level on single-frame products
       - nsrcMeasVisit
       - TE3
       - TE4
-      # tract-level, matched-visit on single-frame products
+    description: |
+      Set of visit-level faro metrics. These tasks run on single-frame products and
+      require Calibrated Source Tables, which are available after
+      consolidateSourceTable (step6) is run.
+  faro_matched:
+    subset:
       - matchCatalogsTract
       - matchCatalogsPatch
       - matchCatalogsPatchMultiBand
@@ -282,17 +286,17 @@ subsets:
       - psfPhotRepStar2
       - psfPhotRepStar3
       - psfPhotRepStar4
-      # tract-level on coadd products
+    description: |
+      Set of tract-level, matched-visit faro metrics. These tasks run on single-frame
+      products and require Calibrated Source Tables, which are available after
+      consolidateSourceTable (step6) is run.
+  faro_tract:
+    subset:
       - TE1
       - TE2
       - wPerp
       - skyObjectMean
       - skyObjectStd
     description: |
-      Set of tasks for calculation of metrics via faro.
-      These tasks are a mix of visit- and tract-level.
-
-      Tasks that require single-frame products use Calibrated Source Tables,
-      which are available after consolidateSourceTable (step2).
-      Tasks that require coadd products use Object Tables which are available
-      after consolidateObjectTable (step3).
+      Set of tract-level faro metrics to be run on coadd products. These use Object
+      Tables which are available after consolidateObjectTable (step3) is run.