Merge pull request #6 from lsst/tickets/DM-35207

DM-35207: add task to produce updated visit summaries

.github/workflows/lint.yaml

@@ -1,22 +1,11 @@
 name: lint
 
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.10"
-
-      - name: Install
-        run: pip install -r <(curl https://raw.githubusercontent.com/lsst/linting/main/requirements.txt)
-
-      - name: Run linter
-        run: flake8
+  call-workflow:
+    uses: lsst/rubin_workflows/.github/workflows/lint.yaml@main

doc/lsst.drp.tasks/index.rst

@@ -18,6 +18,17 @@ lsst.drp.tasks
 .. .. toctree::
 ..    :maxdepth: 1
 
+Task reference
+==============
+
+.. _lsst.drp.tasks-pipeline-tasks:
+
+Pipeline tasks
+--------------
+
+.. lsst-pipelinetasks::
+   :root: lsst.drp.tasks
+
 .. _lsst.drp.tasks-contributing:
 
 Contributing
@@ -46,6 +57,10 @@ You can find Jira issues for this module under the `drp_tasks <https://jira.lsst
 Python API reference
 ====================
 
-.. automodapi:: lsst.drp.tasks
+.. automodapi:: lsst.drp.tasks.gbdesAstrometricFit
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.drp.tasks.update_visit_summary
    :no-main-docstr:
    :no-inheritance-diagram:

doc/lsst.drp.tasks/tasks/lsst.drp.tasks.GbdesAstrometricFitTask.rst → doc/lsst.drp.tasks/tasks/lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask.rst

@@ -1,8 +1,8 @@
-.. lsst-task-topic:: lsst.drp.tasks.GbdesAstrometricFitTask
+.. lsst-task-topic:: lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask
 
-##########
+#######################
 GbdesAstrometricFitTask
-##########
+#######################
 
 ``GbdesAstrometricFitTask`` fits an astrometric solution, or world coordinate system (WCS), for a series of visits.
 Sources in science images are matched with a reference catalog, which allows the fitting algorithm to break degeneracies in the astrometric model.
@@ -13,7 +13,7 @@ This task requires source catalogs for the input images, a reference catalog, an
 The task produces the fitted WCSs, which are described in AST format and are held in `lsst.afw.table.ExposureCatalog`\s called `outputWcs`.
 The task also outputs a table for debugging, `outputCatalog`, which contains the sources used in the fit, along with their residuals with the best-fit model.
 
-.. _lsst.drp.tasks.GbdesAstrometricFitTask-summary:
+.. _lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask-summary:
 
 Processing summary
 ==================
@@ -31,23 +31,23 @@ This uses `WCSFit` from the `gbdes` package (https://github.com/lsst/gbdes/tree/
 The output is in the form of one `lsst.afw.table.ExposureCatalog` for each visit, with a row for each detector.
 The fit WCS is accessed by calling `getWCS()` on the catalog row corresponding to the desired visit and detector.
 
-.. _lsst.drp.tasks.GbdesAstrometricFit-api:
+.. _lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFit-api:
 
 Python API summary
 ==================
 
-.. lsst-task-api-summary:: lsst.drp.tasks.GbdesAstrometricFitTask
+.. lsst-task-api-summary:: lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask
 
-.. _lsst.drp.tasks.GbdesAstrometricFitTask-subtasks:
+.. _lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask-subtasks:
 
 Retargetable subtasks
 =====================
 
-.. lsst-task-config-subtasks:: lsst.drp.tasks.GbdesAstrometricFitTask
+.. lsst-task-config-subtasks:: lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask
 
-.. _lsst.drp.tasks.GbdesAstrometricFitTask-configs:
+.. _lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask-configs:
 
 Configuration fields
 ====================
 
-.. lsst-task-config-fields:: lsst.drp.tasks.GbdesAstrometricFitTask
+.. lsst-task-config-fields:: lsst.drp.tasks.gbdesAstrometricFit.GbdesAstrometricFitTask

doc/lsst.drp.tasks/tasks/lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask.rst

@@ -0,0 +1,52 @@
+.. lsst-task-topic:: lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask
+
+######################
+UpdateVisitSummaryTask
+######################
+
+``UpdateVisitSummaryTask`` combines updated versions of the various `~lsst.afw.image.Exposure` component objects used to characterize and calibrate a single-epoch image into a single per-visit exposure catalog (``finalVisitSummary``).
+It also recomputes summary statistics to reflect these updates.
+
+.. _lsst.drp.tasks.update_visit_summary.UpdateVisitSummary-summary:
+
+Processing summary
+==================
+
+``UpdateVisitSummaryTask`` reads in the initial summary dataset of essentially the same form (``visitSummary``), then replaces the object fields of each record with objects loaded from other (often optional) input datasets that contain newer (often final) versions of those objects.
+When an object field is replaced, any related summary statistics in the catalog's non-object columns are also recomputed.
+
+See connection and ``run`` argument documentation for details.
+
+.. _lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask
+
+.. _lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask-butler:
+
+Butler datasets
+===============
+
+When run through the `~lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask.runQuantum` method, ``UpdateVisitSummaryTask`` obtains datasets from the input Butler data repository and persists outputs to the output Butler data repository.
+
+In this mode, the PSF and aperture correction map are always replaced (since at present all relevant pipelines do recompute these), even though they are optional when calling `lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask.run` directly.
+
+The main output dataset, ``finalVisitSummary`` (by default), can typically be
+used to provide all downstream tasks with the best versions of all calibrations
+for each detector.
+
+.. _lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask
+
+.. _lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask

python/lsst/drp/tasks/__init__.py

@@ -19,5 +19,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-from .gbdesAstrometricFit import *
 from .version import *  # Generated by sconsUtils