lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask Class Reference

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 396 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 437 of file multiBand.py.

    def __init__(self, butler=None, schema=None, peakSchema=None, **kwargs):
        CmdLineTask.__init__(self, **kwargs)
        if schema is None:
            assert butler is not None, "Neither butler nor schema is defined"
            schema = butler.get(self.config.coaddName + "Coadd_mergeDet_schema", immediate=True).schema
        self.schemaMapper = afwTable.SchemaMapper(schema)
        self.schemaMapper.addMinimalSchema(schema)
        self.schema = self.schemaMapper.getOutputSchema()
        if peakSchema is None:
            assert butler is not None, "Neither butler nor peakSchema is defined"
            peakSchema = butler.get(self.config.coaddName + "Coadd_peak_schema", immediate=True).schema

        if self.config.simultaneous:
            self.makeSubtask("multiBandDeblend", schema=self.schema, peakSchema=peakSchema)
        else:
            self.makeSubtask("singleBandDeblend", schema=self.schema, peakSchema=peakSchema)

Member Function Documentation

getExposureId()

def lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.getExposureId	(		self,
			dataRef
	)

Get the ExposureId from a data reference

Definition at line 582 of file multiBand.py.

    def getExposureId(self, dataRef):
        """Get the ExposureId from a data reference
        """
        return int(dataRef.get(self.config.coaddName + "CoaddId"))

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 454 of file multiBand.py.

    def 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.
        """
        catalog = afwTable.SourceCatalog(self.schema)
        return {self.config.coaddName + "Coadd_deblendedFlux": catalog,
                self.config.coaddName + "Coadd_deblendedModel": catalog}

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 509 of file multiBand.py.

    def 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.
        """
        merged = dataRef.get(self.config.coaddName + "Coadd_mergeDet", immediate=True)
        self.log.info("Read %d detections: %s" % (len(merged), dataRef.dataId))
        idFactory = self.makeIdFactory(dataRef)
        for s in merged:
            idFactory.notify(s.getId())
        table = afwTable.SourceTable.make(self.schema, idFactory)
        sources = afwTable.SourceCatalog(table)
        sources.extend(merged, self.schemaMapper)
        return sources

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 466 of file multiBand.py.

    def 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
        """

        if self.config.hasFakes:
            coaddType = "fakes_" + self.config.coaddName
        else:
            coaddType = self.config.coaddName

        if self.config.simultaneous:
            # Use SCARLET to simultaneously deblend across filters
            filters = []
            exposures = []
            for patchRef in patchRefList:
                exposure = patchRef.get(coaddType + "Coadd_calexp", immediate=True)
                filters.append(patchRef.dataId["filter"])
                exposures.append(exposure)
            # The input sources are the same for all bands, since it is a merged catalog
            sources = self.readSources(patchRef)
            exposure = afwImage.MultibandExposure.fromExposures(filters, exposures)
            fluxCatalogs, templateCatalogs = self.multiBandDeblend.run(exposure, sources)
            for n in range(len(patchRefList)):
                self.write(patchRefList[n], fluxCatalogs[filters[n]], templateCatalogs[filters[n]])
        else:
            # Use the singeband deblender to deblend each band separately
            for patchRef in patchRefList:
                exposure = patchRef.get(coaddType + "Coadd_calexp", immediate=True)
                exposure.getPsf().setCacheCapacity(psfCache)
                sources = self.readSources(patchRef)
                self.singleBandDeblend.run(exposure, sources)
                self.write(patchRef, sources)

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 538 of file multiBand.py.

    def 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.
        """
        # The multiband deblender does not have to conserve flux,
        # so only write the flux conserved catalog if it exists
        if flux_sources is not None:
            assert not self.config.simultaneous or self.config.multiBandDeblend.conserveFlux
            dataRef.put(flux_sources, self.config.coaddName + "Coadd_deblendedFlux")
        # Only the multiband deblender has the option to output the
        # template model catalog, which can optionally be used
        # in MeasureMergedCoaddSources
        if template_sources is not None:
            assert self.config.multiBandDeblend.saveTemplates
            dataRef.put(template_sources, self.config.coaddName + "Coadd_deblendedModel")
        self.log.info("Wrote %d sources: %s" % (len(flux_sources), dataRef.dataId))

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 566 of file multiBand.py.

    def 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`.
        """
        for dataRef in dataRefList:
            try:
                metadataName = self._getMetadataName()
                if metadataName is not None:
                    dataRef.put(self.getFullMetadata(), metadataName)
            except Exception as e:
                self.log.warn("Could not persist metadata for dataId=%s: %s", dataRef.dataId, e)

Member Data Documentation

ConfigClass

lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.ConfigClass = DeblendCoaddSourcesConfig

static

Definition at line 423 of file multiBand.py.

makeIdFactory

lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.makeIdFactory = _makeMakeIdFactory("MergedCoaddId")

static

Definition at line 426 of file multiBand.py.

RunnerClass

lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.RunnerClass = DeblendCoaddSourcesRunner

static

Definition at line 424 of file multiBand.py.

schema

lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.schema

Definition at line 444 of file multiBand.py.

schemaMapper

lsst.pipe.tasks.multiBand.DeblendCoaddSourcesTask.schemaMapper

Definition at line 442 of file multiBand.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pipe_tasks/18.1.0-11-gb2589d7b/python/lsst/pipe/tasks/multiBand.py