Update package for forcedPhotCoadd to drp_tasks

lsst · May 25, 2023 · aa72dba · aa72dba
1 parent efb12af
commit aa72dba
Show file tree

Hide file tree

Showing 9 changed files with 415 additions and 2 deletions.
diff --git a/doc/lsst.drp.pipe/index.rst b/doc/lsst.drp.pipe/index.rst
@@ -43,6 +43,13 @@ You can find Jira issues for this module under the `drp_pipe <https://jira.lsstc
 
 .. .. _lsst.drp.pipe-pyapi:
 
+Tasks
+-----
+
+.. lsst-tasks::
+   :root: lsst.drp.pipe
+   :toctree: tasks
+
 Python API reference
 ====================
 

diff --git a/doc/lsst.drp.pipe/tasks/lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.rst b/doc/lsst.drp.pipe/tasks/lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.rst
@@ -0,0 +1,49 @@
+.. lsst-task-topic:: lsst.drp.pipe.forcedPhotCoadd.ForcedPhotCoaddTask
+
+###################
+ForcedPhotCoaddTask
+###################
+
+``ForcedPhotCoaddTask`` performs forced measurement on a co-added image using as a reference catalog detections which were made on coadds in other bands.
+
+Butler datasets
+===============
+
+Input datasets
+--------------
+
+A ``Coadd_src`` variant (e.g. ``deepCoadd_src``)
+   Used as the reference catalog.
+   This is not loaded directly from the provided ``dataRef``; only the patch and tract are used, while the filter is set by the configuration of the references subtask.
+   See ``lsst.meas.base.references.CoaddSrcReferencesTask``.
+
+A ``Coadd_calexp`` variant (e.g. ``deepCoadd_calexp``)
+   Used as the measurement image.
+   Note that this means that :lsst-task:`lsst.pipe.tasks.multiBand.DetectCoaddSourcesTask` must have been run on the image previously.
+
+Ouptut datasets
+---------------
+
+A ``Coadd_forced_src`` variant (e.g. ``deepCoadd_forced_src``)
+   The resulting measurement catalog.
+
+.. _lsst.drp.pipe.forcedPhotCoadd.ForcedPhotCoaddTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask
+
+.. _lsst.drp.pipe.forcedPhotCoadd.ForcedPhotCoaddTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask
+
+.. _lsst.drp.pipe.forcedPhotCoadd.ForcedPhotCoaddTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask
diff --git a/pipelines/_ingredients/DRP-minimal-calibration.yaml b/pipelines/_ingredients/DRP-minimal-calibration.yaml
@@ -37,7 +37,7 @@ tasks:
   transformObjectTable: lsst.pipe.tasks.postprocess.TransformObjectCatalogTask
   consolidateObjectTable: lsst.pipe.tasks.postprocess.ConsolidateObjectTableTask
   forcedPhotCcd: lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask
-  forcedPhotCoadd: lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask
+  forcedPhotCoadd: lsst.drp.tasks.forcedPhotCoadd.ForcedPhotCoaddTask
   selectGoodSeeingVisits:
     class: lsst.pipe.tasks.selectImages.BestSeeingQuantileSelectVisitsTask
     config:

diff --git a/pipelines/_ingredients/HSC/DRP+fakes.yaml b/pipelines/_ingredients/HSC/DRP+fakes.yaml
@@ -132,7 +132,7 @@ tasks:
       connections.inputCoaddName: "fakes_deep"
       connections.exposure: "fakes_calexp"
   forcedPhotCoadd:
-    class: lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask
+    class: lsst.drp.tasks.forcedPhotCoadd.ForcedPhotCoaddTask
     config:
       connections.inputCoaddName: "fakes_deep"
       connections.outputCoaddName: "fakes_deep"
diff --git a/python/lsst/__init__.py b/python/lsst/__init__.py
@@ -0,0 +1,2 @@
+import pkgutil
+__path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/python/lsst/drp/__init__.py b/python/lsst/drp/__init__.py
@@ -0,0 +1,2 @@
+import pkgutil
+__path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/python/lsst/drp/pipe/__init__.py b/python/lsst/drp/pipe/__init__.py
@@ -20,3 +20,5 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 from .version import *  # Generated by sconsUtils
+
+from .forcedPhotCoadd import *