Inheritance diagram for lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask:
Public Member Functions | |
| def | __init__ (self, butler=None, schema=None, peakSchema=None, kwargs) |
| def | getSchemaCatalogs (self) |
| def | runDataRef (self, patchRefList, psfCache=100) |
| def | readSources (self, dataRef) |
| def | write (self, dataRef, flux_sources, template_sources=None) |
| def | writeMetadata (self, dataRefList) |
| def | getExposureId (self, dataRef) |
Public Attributes | |
| schemaMapper | |
| schema | |
Static Public Attributes | |
| ConfigClass = DeblendCoaddSourcesConfig | |
| RunnerClass = DeblendCoaddSourcesRunner | |
| makeIdFactory = _makeMakeIdFactory("MergedCoaddId") | |
Detailed Description
Deblend the sources in a merged catalog
Deblend sources from master catalog in each coadd.
This can either be done separately in each band using the HSC-SDSS deblender
(`DeblendCoaddSourcesTask.config.simultaneous==False`)
or use SCARLET to simultaneously fit the blend in all bands
(`DeblendCoaddSourcesTask.config.simultaneous==True`).
The task will set its own `self.schema` atribute to the `Schema` of the
output deblended catalog.
This will include all fields from the input `Schema`, as well as additional fields
from the deblender.
`pipe.tasks.multiband.DeblendCoaddSourcesTask Description
---------------------------------------------------------
`
Parameters
----------
butler: `Butler`
Butler used to read the input schemas from disk or
construct the reference catalog loader, if `schema` or `peakSchema` or
schema: `Schema`
The schema of the merged detection catalog as an input to this task.
peakSchema: `Schema`
The schema of the `PeakRecord`s in the `Footprint`s in the merged detection catalog
Definition at line 381 of file multiBand.py.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.__init__ | ( | self, | |
butler = None, |
|||
schema = None, |
|||
peakSchema = None, |
|||
| kwargs | |||
| ) |
Definition at line 422 of file multiBand.py.
Member Function Documentation
◆ getExposureId()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.getExposureId | ( | self, | |
| dataRef | |||
| ) |
Get the ExposureId from a data reference
Definition at line 561 of file multiBand.py.
◆ getSchemaCatalogs()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.getSchemaCatalogs | ( | self | ) |
Return a dict of empty catalogs for each catalog dataset produced by this task.
Returns
-------
result: dict
Dictionary of empty catalogs, with catalog names as keys.
Definition at line 439 of file multiBand.py.
◆ readSources()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.readSources | ( | self, | |
| dataRef | |||
| ) |
Read merged catalog
Read the catalog of merged detections and create a catalog
in a single band.
Parameters
----------
dataRef: data reference
Data reference for catalog of merged detections
Returns
-------
sources: `SourceCatalog`
List of sources in merged catalog
We also need to add columns to hold the measurements we're about to make
so we can measure in-place.
Definition at line 488 of file multiBand.py.
◆ runDataRef()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.runDataRef | ( | self, | |
| patchRefList, | |||
psfCache = 100 |
|||
| ) |
Deblend the patch
Deblend each source simultaneously or separately
(depending on `DeblendCoaddSourcesTask.config.simultaneous`).
Set `is-primary` and related flags.
Propagate flags from individual visits.
Write the deblended sources out.
Parameters
----------
patchRefList: list
List of data references for each filter
Definition at line 451 of file multiBand.py.
◆ write()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.write | ( | self, | |
| dataRef, | |||
| flux_sources, | |||
template_sources = None |
|||
| ) |
Write the source catalog(s)
Parameters
----------
dataRef: Data Reference
Reference to the output catalog.
flux_sources: `SourceCatalog`
Flux conserved sources to write to file.
If using the single band deblender, this is the catalog
generated.
template_sources: `SourceCatalog`
Source catalog using the multiband template models
as footprints.
Definition at line 517 of file multiBand.py.
◆ writeMetadata()
| def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.writeMetadata | ( | self, | |
| dataRefList | |||
| ) |
Write the metadata produced from processing the data.
Parameters
----------
dataRefList
List of Butler data references used to write the metadata.
The metadata is written to dataset type `CmdLineTask._getMetadataName`.
Definition at line 545 of file multiBand.py.
Member Data Documentation
◆ ConfigClass
|
static |
Definition at line 408 of file multiBand.py.
◆ makeIdFactory
|
static |
Definition at line 411 of file multiBand.py.
◆ RunnerClass
|
static |
Definition at line 409 of file multiBand.py.
◆ schema
| lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.schema |
Definition at line 429 of file multiBand.py.
◆ schemaMapper
| lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.schemaMapper |
Definition at line 427 of file multiBand.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/multiBand.py
