Skip to content

Commit 8ec52ad

Browse files
WERKSQUADGabor Kovacs
authored and
Gabor Kovacs
committed
Cherry-picking from branch 15554. Pipe_tasks to numpydoc. Conflicts resolved.
1 parent 65f04d3 commit 8ec52ad

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

python/lsst/pipe/tasks/calibrate.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,9 @@ class CalibrateTask(pipeBase.CmdLineTask):
257257
sources and matches. See @ref lsst.meas.astrom.displayAstrometry for
258258
the meaning of the various symbols.
259259
260+
261+
Examples
262+
--------
260263
For example, put something like:
261264
262265
.. code-block:: py
@@ -290,6 +293,35 @@ def DebugInfo(name):
290293

291294
def __init__(self, butler=None, astromRefObjLoader=None,
292295
photoRefObjLoader=None, icSourceSchema=None, **kwargs):
296+
"""Construct a CalibrateTask
297+
298+
Parameters
299+
----------
300+
butler :
301+
The butler is passed to the refObjLoader constructor
302+
in case it is needed. Ignored if the refObjLoader argument
303+
provides a loader directly.
304+
astromRefObjLoader :
305+
An instance of LoadReferenceObjectsTasks
306+
that supplies an external reference catalog for astrometric
307+
calibration. May be None if the desired loader can be constructed
308+
from the butler argument or all steps requiring a reference catalog
309+
are disabled.
310+
photoRefObjLoader :
311+
An instance of LoadReferenceObjectsTasks
312+
that supplies an external reference catalog for photometric
313+
calibration. May be None if the desired loader can be constructed
314+
from the butler argument or all steps requiring a reference catalog
315+
are disabled.
316+
icSourceSchema :
317+
schema for icSource catalog, or None.
318+
Schema values specified in config.icSourceFieldsToCopy will be
319+
taken from this schema. If set to None, no values will be
320+
propagated from the icSourceCatalog
321+
kwargs :
322+
other keyword arguments for
323+
lsst.pipe.base.CmdLineTask
324+
"""
293325
pipeBase.CmdLineTask.__init__(self, **kwargs)
294326

295327
if icSourceSchema is None and butler is not None:

python/lsst/pipe/tasks/characterizeImage.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,25 @@ def DebugInfo(name):
273273
RunnerClass = pipeBase.ButlerInitializedTaskRunner
274274

275275
def __init__(self, butler=None, refObjLoader=None, schema=None, **kwargs):
276+
"""Construct a CharacterizeImageTask
277+
278+
Parameters
279+
----------
280+
butler :
281+
A butler object is passed to the refObjLoader constructor in case
282+
it is needed to load catalogs. May be None if a catalog-based star selector is
283+
not used, if the reference object loader constructor does not require a butler,
284+
or if a reference object loader is passed directly via the refObjLoader argument.
285+
refObjLoader :
286+
An instance of LoadReferenceObjectsTasks that supplies an
287+
external reference catalog to a catalog-based star selector. May be None if a
288+
catalog star selector is not used or the loader can be constructed from the
289+
butler argument.
290+
schema :
291+
initial schema (an lsst.afw.table.SourceTable), or None
292+
kwargs :
293+
other keyword arguments for lsst.pipe.base.CmdLineTask
294+
"""
276295
pipeBase.CmdLineTask.__init__(self, **kwargs)
277296
if schema is None:
278297
schema = SourceTable.makeMinimalSchema()

0 commit comments

Comments
 (0)