Skip to content

Commit

Permalink
Document debug options for SnapCombineTask.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdswinbank committed Jan 6, 2016
1 parent d925f25 commit 8461e33
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions python/lsst/pipe/tasks/snapCombine.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,43 @@ def validate(self):
if self.detection.thresholdPolarity != "both":
raise ValueError("detection.thresholdPolarity must be 'both' for SnapCombineTask")

## \addtogroup LSST_task_documentation
## \{
## \page SnapCombineTask
## \ref SnapCombineTask_ "SnapCombineTask"
## \copybrief SnapCombineTask
## \}

class SnapCombineTask(pipeBase.Task):
"""!
\anchor SnapCombineTask_
\brief Combine snaps.
\section pipe_tasks_snapcombine_Contents Contents
- \ref pipe_tasks_snapcombine_Debug
\section pipe_tasks_snapcombine_Debug Debug variables
The \link lsst.pipe.base.cmdLineTask.CmdLineTask command line task\endlink interface supports a
flag \c -d to import \b debug.py from your \c PYTHONPATH; see <a
href="http://lsst-web.ncsa.illinois.edu/~buildbot/doxygen/x_masterDoxyDoc/base_debug.html">
Using lsstDebug to control debugging output</a> for more about \b debug.py files.
The available variables in SnapCombineTask are:
<DL>
<DT> \c display
<DD> A dictionary containing debug point names as keys with frame number as value. Valid keys are:
<DL>
<DT> repair0
<DD> Display the first snap after repairing.
<DT> repair1
<DD> Display the second snap after repairing.
</DL>
</DD>
</DL>
"""
ConfigClass = SnapCombineConfig
_DefaultName = "snapCombine"

Expand Down

0 comments on commit 8461e33

Please sign in to comment.