@@ -257,6 +257,9 @@ class CalibrateTask(pipeBase.CmdLineTask):
257
257
sources and matches. See @ref lsst.meas.astrom.displayAstrometry for
258
258
the meaning of the various symbols.
259
259
260
+
261
+ Examples
262
+ --------
260
263
For example, put something like:
261
264
262
265
.. code-block:: py
@@ -290,6 +293,35 @@ def DebugInfo(name):
290
293
291
294
def __init__ (self , butler = None , astromRefObjLoader = None ,
292
295
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
+ """
293
325
pipeBase .CmdLineTask .__init__ (self , ** kwargs )
294
326
295
327
if icSourceSchema is None and butler is not None :
0 commit comments