-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert block to numpydoc and create new task topic types
- Loading branch information
Showing
10 changed files
with
300 additions
and
180 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.BasePsfDeterminerTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.BasePsfDeterminerTask | ||
|
||
##################### | ||
BasePsfDeterminerTask | ||
##################### | ||
|
||
``BasePsfDeterminerTask`` is the base class for PSF determiners: override ``determinePsf`` to implement your algorithm, and register your new Task with ``psfDeterminerRegistry`` to allow it to be used in a pipeline. | ||
|
||
|
||
.. _lsst.meas.algorithms.BasePsfDeterminerTask-api: | ||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.BasePsfDeterminerTask | ||
|
||
.. _lsst.meas.algorithms.BasePsfDeterminerTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.BasePsfDeterminerTask | ||
|
||
.. _lsst.meas.algorithms.BasePsfDeterminerTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.BasePsfDeterminerTask |
30 changes: 30 additions & 0 deletions
30
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.MakePsfCandidatesTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.MakePsfCandidatesTask | ||
|
||
##################### | ||
MakePsfCandidatesTask | ||
##################### | ||
|
||
``MakePsfCandidatesTask`` creates PSF candidates given an input catalog. | ||
|
||
.. _lsst.meas.algorithms.MakePsfCandidatesTask-api: | ||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.MakePsfCandidatesTask | ||
|
||
.. _lsst.meas.algorithms.MakePsfCandidatesTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.MakePsfCandidatesTask | ||
|
||
.. _lsst.meas.algorithms.MakePsfCandidatesTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.MakePsfCandidatesTask | ||
|
||
.. _lsst.meas.algorithms.MakePsfCandidatesTask-examples: |
28 changes: 28 additions & 0 deletions
28
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.MatcherSourceSelectorTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.MatcherSourceSelectorTask | ||
|
||
######################### | ||
MatcherSourceSelectorTask | ||
######################### | ||
|
||
``MatcherSourceSelectorTask`` selects sources that are useful for matching, without checking footprints or bad flags. | ||
|
||
.. _lsst.meas.algorithms.MatcherSourceSelectorTask-api: | ||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.MatcherSourceSelectorTask | ||
|
||
.. _lsst.meas.algorithms.MatcherSourceSelectorTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.MatcherSourceSelectorTask | ||
|
||
.. _lsst.meas.algorithms.MatcherSourceSelectorTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.MatcherSourceSelectorTask |
41 changes: 41 additions & 0 deletions
41
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.MeasureApCorrTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.MeasureApCorrTask | ||
|
||
################# | ||
MeasureApCorrTask | ||
################# | ||
|
||
``MeasureApCorrTask`` measures aperture correction for the flux fields returned by `lsst.meas.base.getApCorrNameSet`. | ||
|
||
.. _lsst.meas.algorithms.MeasureApCorrTask-api: | ||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.MeasureApCorrTask | ||
|
||
.. _lsst.meas.algorithms.MeasureApCorrTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.MeasureApCorrTask | ||
|
||
.. _lsst.meas.algorithms.MeasureApCorrTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.MeasureApCorrTask | ||
|
||
.. _lsst.meas.algorithms.MeasureApCorrTask-debug: | ||
|
||
Debugging | ||
========= | ||
|
||
MeasureApCorrTask has a debug dictionary containing two boolean keys: | ||
|
||
doPause | ||
bool; Pause to inspect the residuals plot? If False, there will be a 4 second delay to allow for inspection of the plot before closing it and moving on. | ||
|
||
display | ||
bool; if True display debug information |
50 changes: 50 additions & 0 deletions
50
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.ObjectSizeStarSelectorTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.ObjectSizeStarSelectorTask | ||
|
||
########################## | ||
ObjectSizeStarSelectorTask | ||
########################## | ||
|
||
``ObjectSizeStarSelectorTask`` selects likely stars by looking for a cluster of small objects in a size-magnitude plot. | ||
|
||
.. _lsst.meas.algorithms.ObjectSizeStarSelectorTask-api: | ||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.ObjectSizeStarSelectorTask | ||
|
||
.. _lsst.meas.algorithms.ObjectSizeStarSelectorTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.ObjectSizeStarSelectorTask | ||
|
||
.. _lsst.meas.algorithms.ObjectSizeStarSelectorTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.ObjectSizeStarSelectorTask | ||
|
||
.. _lsst.meas.algorithms.ObjectSizeStarSelectorTask-debug: | ||
|
||
Debugging | ||
========= | ||
|
||
ObjectSizeStarSelectorTask has a debug dictionary with the following boolean keys: | ||
|
||
display | ||
bool; if True display debug information | ||
|
||
displayExpsoure | ||
bool; if True display the exposure and spatial cells | ||
|
||
plotMagSize | ||
bool; if True display the magnitude-size relation using matplotlib | ||
|
||
dumpData | ||
bool; if True dump data to a pickle file | ||
|
||
|
||
More information can be found in `lsstDebug`. |
27 changes: 27 additions & 0 deletions
27
doc/lsst.meas.algorithms/tasks/lsst.meas.algorithms.PcaPsfDeterminerTask.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.. lsst-task-topic:: lsst.meas.algorithms.PcaPsfDeterminerTask | ||
|
||
#################### | ||
PcaPsfDeterminerTask | ||
#################### | ||
|
||
``PcaPsfDeterminerTask`` estimates PSFs of pre-selected likely stars using a PCA decomposition approach. | ||
|
||
|
||
Python API summary | ||
================== | ||
|
||
.. lsst-task-api-summary:: lsst.meas.algorithms.PcaPsfDeterminerTask | ||
|
||
.. _lsst.meas.algorithms.PcaPsfDeterminerTask-subtasks: | ||
|
||
Retargetable subtasks | ||
===================== | ||
|
||
.. lsst-task-config-subtasks:: lsst.meas.algorithms.PcaPsfDeterminerTask | ||
|
||
.. _lsst.meas.algorithms.PcaPsfDeterminerTask-configs: | ||
|
||
Configuration fields | ||
==================== | ||
|
||
.. lsst-task-config-fields:: lsst.meas.algorithms.PcaPsfDeterminerTask |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.