lsst.pipe.tasks g35da1f9f46+5103007272
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitSubTask Class Reference
Inheritance diagram for lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitSubTask:

Public Member Functions

 __init__ (self, **kwargs)
 
pipeBase.Struct run (self, Iterable[CatalogExposureInputs] catexps, afwTable.SourceCatalog cat_ref)
 

Static Public Attributes

 ConfigClass = CoaddMultibandFitSubConfig
 

Detailed Description

Subtask interface for multiband fitting of deblended sources.

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

Definition at line 188 of file fit_coadd_multiband.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitSubTask.__init__ (   self,
**  kwargs 
)

Definition at line 199 of file fit_coadd_multiband.py.

Member Function Documentation

◆ run()

pipeBase.Struct lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitSubTask.run (   self,
Iterable[CatalogExposureInputs catexps,
afwTable.SourceCatalog   cat_ref 
)
Fit models to deblended sources from multi-band inputs.

Parameters
----------
catexps : `typing.List [CatalogExposureInputs]`
    A list of catalog-exposure pairs with metadata in a given band.
cat_ref : `lsst.afw.table.SourceCatalog`
    A reference source catalog to fit.

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 203 of file fit_coadd_multiband.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitSubTask.ConfigClass = CoaddMultibandFitSubConfig
static

Definition at line 197 of file fit_coadd_multiband.py.


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