lsst.pipe.tasks  21.0.0-119-g1a9a5132+45e0dac908
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.fit_multiband.MultibandFitSubTask Class Reference
Inheritance diagram for lsst.pipe.tasks.fit_multiband.MultibandFitSubTask:

Public Member Functions

def __init__ (self, afwTable.Schema schema, **kwargs)
 
pipeBase.Struct run (self, Iterable[CatalogExposure] catexps, afwTable.SourceCatalog cat_ref)
 
afwTable.Schema schema (self)
 

Static Public Attributes

 ConfigClass = MultibandFitSubConfig
 

Detailed Description

An abstract interface for subtasks of MultibandFitTask to perform
multiband fitting of deblended sources.

Parameters
----------
schema : `lsst.afw.table.Schema`
    The input schema for the reference source catalog, used to initialize
    the output schema.
**kwargs
    Additional arguments to be passed to the `lsst.pipe.base.Task`
    constructor.

Definition at line 203 of file fit_multiband.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.fit_multiband.MultibandFitSubTask.__init__ (   self,
afwTable.Schema  schema,
**  kwargs 
)

Definition at line 218 of file fit_multiband.py.

Member Function Documentation

◆ run()

pipeBase.Struct lsst.pipe.tasks.fit_multiband.MultibandFitSubTask.run (   self,
Iterable[CatalogExposure catexps,
afwTable.SourceCatalog   cat_ref 
)
Fit sources from a reference catalog using data from multiple
exposures in the same patch.

Parameters
----------
catexps : `typing.List [CatalogExposure]`
    A list of catalog-exposure pairs 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 222 of file fit_multiband.py.

◆ schema()

afwTable.Schema lsst.pipe.tasks.fit_multiband.MultibandFitSubTask.schema (   self)

Definition at line 255 of file fit_multiband.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.fit_multiband.MultibandFitSubTask.ConfigClass = MultibandFitSubConfig
static

Definition at line 216 of file fit_multiband.py.


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