LSST Applications g0da5cf3356+25b44625d0,g17e5ecfddb+50a5ac4092,g1c76d35bf8+585f0f68a2,g295839609d+8ef6456700,g2e2c1a68ba+cc1f6f037e,g38293774b4+62d12e78cb,g3b44f30a73+2891c76795,g48ccf36440+885b902d19,g4b2f1765b6+0c565e8f25,g5320a0a9f6+bd4bf1dc76,g56364267ca+403c24672b,g56b687f8c9+585f0f68a2,g5c4744a4d9+78cd207961,g5ffd174ac0+bd4bf1dc76,g6075d09f38+3075de592a,g667d525e37+cacede5508,g6f3e93b5a3+da81c812ee,g71f27ac40c+cacede5508,g7212e027e3+eb621d73aa,g774830318a+18d2b9fa6c,g7985c39107+62d12e78cb,g79ca90bc5c+fa2cc03294,g881bdbfe6c+cacede5508,g91fc1fa0cf+82a115f028,g961520b1fb+2534687f64,g96f01af41f+f2060f23b6,g9ca82378b8+cacede5508,g9d27549199+78cd207961,gb065e2a02a+ad48cbcda4,gb1df4690d6+585f0f68a2,gb35d6563ee+62d12e78cb,gbc3249ced9+bd4bf1dc76,gbec6a3398f+bd4bf1dc76,gd01420fc67+bd4bf1dc76,gd59336e7c4+c7bb92e648,gf46e8334de+81c9a61069,gfed783d017+bd4bf1dc76,v25.0.1.rc3
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.

218 def __init__(self, schema: afwTable.Schema, **kwargs):
219 super().__init__(**kwargs)
220

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.

224 ) -> pipeBase.Struct:
225 """Fit sources from a reference catalog using data from multiple
226 exposures in the same patch.
227
228 Parameters
229 ----------
230 catexps : `typing.List [CatalogExposure]`
231 A list of catalog-exposure pairs in a given band.
233 A reference source catalog to fit.
234
235 Returns
236 -------
237 retStruct : `lsst.pipe.base.Struct`
238 A struct with a cat_output attribute containing the output
239 measurement catalog.
240
241 Notes
242 -----
243 Subclasses may have further requirements on the input parameters,
244 including:
245 - Passing only one catexp per band;
246 - Catalogs containing HeavyFootprints with deblended images;
247 - Fitting only a subset of the sources.
248 If any requirements are not met, the subtask should fail as soon as
249 possible.
250 """
251 raise NotImplementedError()
252

◆ schema()

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

Definition at line 255 of file fit_multiband.py.

255 def schema(self) -> afwTable.Schema:
256 raise NotImplementedError()
257
258
table::Schema schema
Definition: python.h:134

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: