Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-39221: Update package for forcedPhotCoadd to drp_tasks #67

Merged
merged 1 commit into from
May 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/lsst.drp.pipe/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
====================

Expand Down
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion pipelines/_ingredients/DRP-minimal-calibration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pipelines/_ingredients/HSC/DRP+fakes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 2 additions & 0 deletions python/lsst/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import pkgutil
__path__ = pkgutil.extend_path(__path__, __name__)
2 changes: 2 additions & 0 deletions python/lsst/drp/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import pkgutil
__path__ = pkgutil.extend_path(__path__, __name__)
2 changes: 2 additions & 0 deletions python/lsst/drp/pipe/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 *