lsst.meas.deblender  16.0-8-g4dec96c+32
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.deblender.deblend.MultibandDeblendTask Class Reference
Inheritance diagram for lsst.meas.deblender.deblend.MultibandDeblendTask:

Public Member Functions

def __init__ (self, schema, peakSchema=None, kwargs)
 
def run (self, mExposure, mergedSources)
 
def deblend (self, mExposure, sources, psfs)
 
def preSingleDeblendHook (self, exposures, sources, pk, fp, psfs, psf_fwhms, sigmas)
 
def postSingleDeblendHook (self, exposures, fluxCatalogs, templateCatalogs, pk, npre, fp, psfs, psf_fwhms, sigmas, result)
 
def isLargeFootprint (self, footprint)
 
def isMasked (self, footprint, mask)
 
def skipParent (self, source, masks)
 

Public Attributes

 peakSchemaMapper
 
 schema
 
 plugins
 
 runtimeKey
 
 nChildKey
 
 psfKey
 
 tooManyPeaksKey
 
 tooBigKey
 
 maskedKey
 
 deblendFailedKey
 
 deblendSkippedKey
 
 psfCenterKey
 
 psfFluxKey
 
 deblendRampedTemplateKey
 
 deblendPatchedTemplateKey
 
 hasStrayFluxKey
 

Static Public Attributes

 ConfigClass = MultibandDeblendConfig
 

Detailed Description

MultibandDeblendTask

Split blended sources into individual sources.

This task has no return value; it only modifies the SourceCatalog in-place.

Definition at line 657 of file deblend.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.deblender.deblend.MultibandDeblendTask.__init__ (   self,
  schema,
  peakSchema = None,
  kwargs 
)
Create the task, adding necessary fields to the given schema.

Parameters
----------
schema: `lsst.afw.table.schema.schema.Schema`
    Schema object for measurement fields; will be modified in-place.
peakSchema: `lsst.afw.table.schema.schema.Schema`
    Schema of Footprint Peaks that will be passed to the deblender.
    Any fields beyond the PeakTable minimal schema will be transferred
    to the main source Schema.  If None, no fields will be transferred
    from the Peaks.
filters: list of str
    Names of the filters used for the eposures. This is needed to store the SED as a field
**kwargs
    Passed to Task.__init__.

Definition at line 667 of file deblend.py.

Member Function Documentation

◆ deblend()

def lsst.meas.deblender.deblend.MultibandDeblendTask.deblend (   self,
  mExposure,
  sources,
  psfs 
)
Deblend a data cube of multiband images

Parameters
----------
mExposure: `MultibandExposure`
    The exposures should be co-added images of the same
    shape and region of the sky.
sources: `SourceCatalog`
    The merged `SourceCatalog` that contains parent footprints
    to (potentially) deblend.
psfs: dict
    Keys are the names of the filters
    (should be the same as `mExposure.filters`)
    and the values are the PSFs in each band.

Returns
-------
fluxCatalogs: dict or None
    Keys are the names of the filters and the values are
    `lsst.afw.table.source.source.SourceCatalog`'s.
    These are the flux-conserved catalogs with heavy footprints with
    the image data weighted by the multiband templates.
    If `self.config.conserveFlux` is `False`, then this item will be None
templateCatalogs: dict or None
    Keys are the names of the filters and the values are
    `lsst.afw.table.source.source.SourceCatalog`'s.
    These are catalogs with heavy footprints that are the templates
    created by the multiband templates.
    If `self.config.saveTemplates` is `False`, then this item will be None

Definition at line 887 of file deblend.py.

◆ isLargeFootprint()

def lsst.meas.deblender.deblend.MultibandDeblendTask.isLargeFootprint (   self,
  footprint 
)
Returns whether a Footprint is large

'Large' is defined by thresholds on the area, size and axis ratio.
These may be disabled independently by configuring them to be non-positive.

This is principally intended to get rid of satellite streaks, which the
deblender or other downstream processing can have trouble dealing with
(e.g., multiple large HeavyFootprints can chew up memory).

Definition at line 1131 of file deblend.py.

◆ isMasked()

def lsst.meas.deblender.deblend.MultibandDeblendTask.isMasked (   self,
  footprint,
  mask 
)
Returns whether the footprint violates the mask limits

Definition at line 1153 of file deblend.py.

◆ postSingleDeblendHook()

def lsst.meas.deblender.deblend.MultibandDeblendTask.postSingleDeblendHook (   self,
  exposures,
  fluxCatalogs,
  templateCatalogs,
  pk,
  npre,
  fp,
  psfs,
  psf_fwhms,
  sigmas,
  result 
)

Definition at line 1128 of file deblend.py.

◆ preSingleDeblendHook()

def lsst.meas.deblender.deblend.MultibandDeblendTask.preSingleDeblendHook (   self,
  exposures,
  sources,
  pk,
  fp,
  psfs,
  psf_fwhms,
  sigmas 
)

Definition at line 1124 of file deblend.py.

◆ run()

def lsst.meas.deblender.deblend.MultibandDeblendTask.run (   self,
  mExposure,
  mergedSources 
)
Get the psf from each exposure and then run deblend().

Parameters
----------
mExposure: `MultibandExposure`
    The exposures should be co-added images of the same
    shape and region of the sky.
mergedSources: `SourceCatalog`
    The merged `SourceCatalog` that contains parent footprints
    to (potentially) deblend.

Returns
-------
fluxCatalogs: dict or None
    Keys are the names of the filters and the values are
    `lsst.afw.table.source.source.SourceCatalog`'s.
    These are the flux-conserved catalogs with heavy footprints with
    the image data weighted by the multiband templates.
    If `self.config.conserveFlux` is `False`, then this item will be None
templateCatalogs: dict or None
    Keys are the names of the filters and the values are
    `lsst.afw.table.source.source.SourceCatalog`'s.
    These are catalogs with heavy footprints that are the templates
    created by the multiband templates.
    If `self.config.saveTemplates` is `False`, then this item will be None

Definition at line 833 of file deblend.py.

◆ skipParent()

def lsst.meas.deblender.deblend.MultibandDeblendTask.skipParent (   self,
  source,
  masks 
)
Indicate that the parent source is not being deblended

We set the appropriate flags and masks for each exposure.

Parameters
----------
source: `lsst.afw.table.source.source.SourceRecord`
    The source to flag as skipped
masks: list of `lsst.afw.image.MaskX`
    The mask in each band to update with the non-detection

Definition at line 1163 of file deblend.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.deblender.deblend.MultibandDeblendTask.ConfigClass = MultibandDeblendConfig
static

Definition at line 664 of file deblend.py.

◆ deblendFailedKey

lsst.meas.deblender.deblend.MultibandDeblendTask.deblendFailedKey

Definition at line 802 of file deblend.py.

◆ deblendPatchedTemplateKey

lsst.meas.deblender.deblend.MultibandDeblendTask.deblendPatchedTemplateKey

Definition at line 819 of file deblend.py.

◆ deblendRampedTemplateKey

lsst.meas.deblender.deblend.MultibandDeblendTask.deblendRampedTemplateKey

Definition at line 814 of file deblend.py.

◆ deblendSkippedKey

lsst.meas.deblender.deblend.MultibandDeblendTask.deblendSkippedKey

Definition at line 805 of file deblend.py.

◆ hasStrayFluxKey

lsst.meas.deblender.deblend.MultibandDeblendTask.hasStrayFluxKey

Definition at line 824 of file deblend.py.

◆ maskedKey

lsst.meas.deblender.deblend.MultibandDeblendTask.maskedKey

Definition at line 800 of file deblend.py.

◆ nChildKey

lsst.meas.deblender.deblend.MultibandDeblendTask.nChildKey

Definition at line 791 of file deblend.py.

◆ peakSchemaMapper

lsst.meas.deblender.deblend.MultibandDeblendTask.peakSchemaMapper

Definition at line 694 of file deblend.py.

◆ plugins

lsst.meas.deblender.deblend.MultibandDeblendTask.plugins

Definition at line 763 of file deblend.py.

◆ psfCenterKey

lsst.meas.deblender.deblend.MultibandDeblendTask.psfCenterKey

Definition at line 810 of file deblend.py.

◆ psfFluxKey

lsst.meas.deblender.deblend.MultibandDeblendTask.psfFluxKey

Definition at line 812 of file deblend.py.

◆ psfKey

lsst.meas.deblender.deblend.MultibandDeblendTask.psfKey

Definition at line 793 of file deblend.py.

◆ runtimeKey

lsst.meas.deblender.deblend.MultibandDeblendTask.runtimeKey

Definition at line 789 of file deblend.py.

◆ schema

lsst.meas.deblender.deblend.MultibandDeblendTask.schema

Definition at line 707 of file deblend.py.

◆ tooBigKey

lsst.meas.deblender.deblend.MultibandDeblendTask.tooBigKey

Definition at line 798 of file deblend.py.

◆ tooManyPeaksKey

lsst.meas.deblender.deblend.MultibandDeblendTask.tooManyPeaksKey

Definition at line 795 of file deblend.py.


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