lsst.pipe.tasks.fit_multiband.MultibandFitTask Class Reference

Inheritance diagram for lsst.pipe.tasks.fit_multiband.MultibandFitTask:

Public Member Functions
def	__init__ (self, initInputs, **kwargs)
def	runQuantum (self, butlerQC, inputRefs, outputRefs)
pipeBase.Struct	run (self, List[CatalogExposure] catexps, afwTable.SourceCatalog cat_ref)

Public Attributes
	cat_output_schema

Static Public Attributes
	ConfigClass = MultibandFitConfig

Detailed Description

Fit deblended exposures in multiple bands simultaneously.

It is generally assumed but not enforced (except optionally by the
configurable `fit_multiband` subtask) that there is only one exposure
per band, presumably a coadd.

Definition at line 289 of file fit_multiband.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.fit_multiband.MultibandFitTask.__init__	(		self,
			initInputs,
		**	kwargs
	)

Definition at line 299 of file fit_multiband.py.

    def __init__(self, initInputs, **kwargs):
        super().__init__(initInputs=initInputs, **kwargs)
        self.makeSubtask("fit_multiband", schema=initInputs["cat_ref_schema"].schema)
        self.cat_output_schema = afwTable.SourceCatalog(self.fit_multiband.schema)
 

Member Function Documentation

run()

pipeBase.Struct lsst.pipe.tasks.fit_multiband.MultibandFitTask.run	(		self,
		List[CatalogExposure]	catexps,
		afwTable.SourceCatalog	cat_ref
	)

Fit sources from a reference catalog using data from multiple
exposures in the same region (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
-----
Subtasks may have further requirements; see `MultibandFitSubTask.run`.

Definition at line 326 of file fit_multiband.py.

    def run(self, catexps: List[CatalogExposure], cat_ref: afwTable.SourceCatalog) -> pipeBase.Struct:
        """Fit sources from a reference catalog using data from multiple
        exposures in the same region (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
        -----
        Subtasks may have further requirements; see `MultibandFitSubTask.run`.
        """
        cat_output = self.fit_multiband.run(catexps, cat_ref).output
        retStruct = pipeBase.Struct(cat_output=cat_output)
        return retStruct

runQuantum()

def lsst.pipe.tasks.fit_multiband.MultibandFitTask.runQuantum	(		self,
			butlerQC,
			inputRefs,
			outputRefs
	)

Definition at line 304 of file fit_multiband.py.

    def runQuantum(self, butlerQC, inputRefs, outputRefs):
        inputs = butlerQC.get(inputRefs)
        id_tp = ExposureIdInfo.fromDataId(butlerQC.quantum.dataId, "tract_patch").expId
        input_refs_objs = [(inputRefs.cats_meas, inputs['cats_meas']), (inputRefs.coadds, inputs['coadds'])]
        cats, exps = [
            {dRef.dataId: obj for dRef, obj in zip(refs, objs)}
            for refs, objs in input_refs_objs
        ]
        dataIds = set(cats).union(set(exps))
        catexps = [
            CatalogExposure(
                catalog=cats.get(dataId), exposure=exps.get(dataId), dataId=dataId, id_tract_patch=id_tp,
            )
            for dataId in dataIds
        ]
        outputs = self.run(catexps=catexps, cat_ref=inputs['cat_ref'])
        butlerQC.put(outputs, outputRefs)
        # Validate the output catalog's schema and raise if inconsistent (after output to allow debugging)
        if outputs.cat_output.schema != self.cat_output_schema.schema:
            raise RuntimeError(f'{__class__}.config.fit_multiband.run schema != initOutput schema:'
                               f' {outputs.cat_output.schema} vs {self.cat_output_schema.schema}')
 

Member Data Documentation

cat_output_schema

lsst.pipe.tasks.fit_multiband.MultibandFitTask.cat_output_schema

Definition at line 302 of file fit_multiband.py.

ConfigClass

lsst.pipe.tasks.fit_multiband.MultibandFitTask.ConfigClass = MultibandFitConfig

static

Definition at line 296 of file fit_multiband.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/pipe_tasks/g91fc1fa0cf+82a115f028/python/lsst/pipe/tasks/fit_multiband.py