lsst.pipe.tasks gdffeac4cd3+e4d909b13f
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.fit_coadd_psf.CoaddPsfFitSubTask Class Reference
Inheritance diagram for lsst.pipe.tasks.fit_coadd_psf.CoaddPsfFitSubTask:

Public Member Functions

 __init__ (self, **kwargs)
 
pipeBase.Struct run (self, CatalogExposurePsf catexp)
 

Static Public Attributes

 ConfigClass = CoaddPsfFitSubConfig
 

Detailed Description

Interface for CoaddPsfFitTask subtasks to fit PSFs.

Parameters
----------
**kwargs
    Additional arguments to be passed to the `lsst.pipe.base.Task`
    constructor.

Definition at line 85 of file fit_coadd_psf.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pipe.tasks.fit_coadd_psf.CoaddPsfFitSubTask.__init__ (   self,
**  kwargs 
)

Definition at line 96 of file fit_coadd_psf.py.

Member Function Documentation

◆ run()

pipeBase.Struct lsst.pipe.tasks.fit_coadd_psf.CoaddPsfFitSubTask.run (   self,
CatalogExposurePsf   catexp 
)
Fit PSF images at locations of sources in a single exposure.

Parameters
----------
catexp : `CatalogExposurePsf`
    An exposure to fit a model PSF at the position of all
    sources in the corresponding catalog.

Returns
-------
retStruct : `lsst.pipe.base.Struct`
    A struct with a cat_output attribute containing the output
    measurement catalog.

Notes
-----
Subclasses may have further requirements on the input parameters,
including:
    - Passing only one catexp per band;
    - Catalogs containing HeavyFootprints with deblended images;
    - Fitting only a subset of the sources.
If any requirements are not met, the subtask should fail as soon as
possible.

Definition at line 100 of file fit_coadd_psf.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.fit_coadd_psf.CoaddPsfFitSubTask.ConfigClass = CoaddPsfFitSubConfig
static

Definition at line 94 of file fit_coadd_psf.py.


The documentation for this class was generated from the following file: