Update task documentation

lsst · Jul 16, 2021 · 3747d66 · 3747d66
1 parent 48c7347
commit 3747d66
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 1 deletion.
diff --git a/...lsst.meas.algorithms/tasks/lsst.meas.algorithms.ReferenceSourceSelectorTask.rst b/...lsst.meas.algorithms/tasks/lsst.meas.algorithms.ReferenceSourceSelectorTask.rst
@@ -0,0 +1,28 @@
+.. lsst-task-topic:: lsst.meas.algorithms.ReferenceSourceSelectorTask
+
+###########################
+ReferenceSourceSelectorTask
+###########################
+
+``ReferenceSourceSelectorTask`` selects reference sources by optionally applying a magnitude limit, flag requirements and color limits.
+
+.. _lsst.meas.algorithms.ReferenceSourceSelectorTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.meas.algorithms.ReferenceSourceSelectorTask
+
+.. _lsst.meas.algorithms.ReferenceSourceSelectorTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.meas.algorithms.ReferenceSourceSelectorTask
+
+.. _lsst.meas.algorithms.ReferenceSourceSelectorTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.meas.algorithms.ReferenceSourceSelectorTask
diff --git a/doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.ScienceSourceSelectorTask.rst b/doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.ScienceSourceSelectorTask.rst
@@ -0,0 +1,28 @@
+.. lsst-task-topic:: lsst.meas.algorithms.ScienceSourceSelectorTask
+
+#########################
+ScienceSourceSelectorTask
+#########################
+
+``ScienceSourceSelectorTask`` selects sources from images being processed by optionally applying magnitude limits, flag requirements and star/galaxy separation.
+
+.. _lsst.meas.algorithms.ScienceSourceSelectorTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.meas.algorithms.ScienceSourceSelectorTask
+
+.. _lsst.meas.algorithms.ScienceSourceSelectorTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.meas.algorithms.ScienceSourceSelectorTask
+
+.. _lsst.meas.algorithms.ScienceSourceSelectorTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.meas.algorithms.ScienceSourceSelectorTask
diff --git a/doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.SkyObjectsTask.rst b/doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.SkyObjectsTask.rst
@@ -0,0 +1,28 @@
+.. lsst-task-topic:: lsst.meas.algorithms.SkyObjectsTask
+
+##############
+SkyObjectsTask
+##############
+
+``SkyObjectsTask`` generates a list of Footprints of sky objects.
+
+.. _lsst.meas.algorithms.SkyObjectsTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.meas.algorithms.SkyObjectsTask
+
+.. _lsst.meas.algorithms.SkyObjectsTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.meas.algorithms.SkyObjectsTask
+
+.. _lsst.meas.algorithms.SkyObjectsTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.meas.algorithms.SkyObjectsTask
diff --git a/python/lsst/meas/algorithms/skyObjects.py b/python/lsst/meas/algorithms/skyObjects.py
@@ -92,8 +92,9 @@ def generateSkyObjects(mask, seed, config):
 
 
 class SkyObjectsTask(Task):
+    """Generate a list of Footprints of sky objects.
+    """
     ConfigClass = SkyObjectsConfig
-
     def run(self, mask, seed):
         """Generate a list of Footprints of sky objects