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-30902: Numpydoc conversion of meas_algorithms through stamps.py #248

Merged
merged 1 commit into from
Jul 16, 2021
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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions python/lsst/meas/algorithms/skyObjects.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ def generateSkyObjects(mask, seed, config):


class SkyObjectsTask(Task):
"""Generate a list of Footprints of sky objects.
parejkoj marked this conversation as resolved.
Show resolved Hide resolved
"""
ConfigClass = SkyObjectsConfig

def run(self, mask, seed):
Expand Down