lsst.meas.deblender  20.0.0+10
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.deblender.deblend.SourceDeblendTask Class Reference

Split blended sources into individual sources. More...

Inheritance diagram for lsst.meas.deblender.deblend.SourceDeblendTask:

Public Member Functions

def __init__ (self, schema, peakSchema=None, **kwargs)
 Create the task, adding necessary fields to the given schema. More...
 
def addSchemaKeys (self, schema)
 
def run (self, exposure, sources)
 Get the psf from the provided exposure and then run deblend(). More...
 
def deblend (self, exposure, srcs, psf)
 Deblend. More...
 
def preSingleDeblendHook (self, exposure, srcs, i, fp, psf, psf_fwhm, sigma1)
 
def postSingleDeblendHook (self, exposure, srcs, i, npre, kids, fp, psf, psf_fwhm, sigma1, res)
 
def isLargeFootprint (self, footprint)
 
def isMasked (self, footprint, mask)
 
def skipParent (self, source, mask)
 

Public Attributes

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

Static Public Attributes

 ConfigClass = SourceDeblendConfig
 

Detailed Description

Split blended sources into individual sources.

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

Definition at line 150 of file deblend.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.deblender.deblend.SourceDeblendTask.__init__ (   self,
  schema,
  peakSchema = None,
**  kwargs 
)

Create the task, adding necessary fields to the given schema.

Parameters
[in,out]schemaSchema object for measurement fields; will be modified in-place.
[in]peakSchemaSchema 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.
[in]**kwargsPassed to Task.__init__.

Definition at line 161 of file deblend.py.

Member Function Documentation

◆ addSchemaKeys()

def lsst.meas.deblender.deblend.SourceDeblendTask.addSchemaKeys (   self,
  schema 
)

Definition at line 194 of file deblend.py.

◆ deblend()

def lsst.meas.deblender.deblend.SourceDeblendTask.deblend (   self,
  exposure,
  srcs,
  psf 
)

Deblend.

Parameters
[in]exposureExposure to process
[in,out]srcsSourceCatalog containing sources detected on this exposure.
[in]psfPSF
Returns
None

Definition at line 256 of file deblend.py.

◆ isLargeFootprint()

def lsst.meas.deblender.deblend.SourceDeblendTask.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 421 of file deblend.py.

◆ isMasked()

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

Definition at line 443 of file deblend.py.

◆ postSingleDeblendHook()

def lsst.meas.deblender.deblend.SourceDeblendTask.postSingleDeblendHook (   self,
  exposure,
  srcs,
  i,
  npre,
  kids,
  fp,
  psf,
  psf_fwhm,
  sigma1,
  res 
)

Definition at line 418 of file deblend.py.

◆ preSingleDeblendHook()

def lsst.meas.deblender.deblend.SourceDeblendTask.preSingleDeblendHook (   self,
  exposure,
  srcs,
  i,
  fp,
  psf,
  psf_fwhm,
  sigma1 
)

Definition at line 415 of file deblend.py.

◆ run()

def lsst.meas.deblender.deblend.SourceDeblendTask.run (   self,
  exposure,
  sources 
)

Get the psf from the provided exposure and then run deblend().

Parameters
[in]exposureExposure to process
[in,out]sourcesSourceCatalog containing sources detected on this exposure.
Returns
None

Definition at line 237 of file deblend.py.

◆ skipParent()

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

We set the appropriate flags and mask.

@param source  The source to flag as skipped
@param mask  The mask to update

Definition at line 453 of file deblend.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.deblender.deblend.SourceDeblendTask.ConfigClass = SourceDeblendConfig
static

Definition at line 158 of file deblend.py.

◆ deblendFailedKey

lsst.meas.deblender.deblend.SourceDeblendTask.deblendFailedKey

Definition at line 212 of file deblend.py.

◆ deblendPatchedTemplateKey

lsst.meas.deblender.deblend.SourceDeblendTask.deblendPatchedTemplateKey

Definition at line 223 of file deblend.py.

◆ deblendRampedTemplateKey

lsst.meas.deblender.deblend.SourceDeblendTask.deblendRampedTemplateKey

Definition at line 218 of file deblend.py.

◆ deblendSkippedKey

lsst.meas.deblender.deblend.SourceDeblendTask.deblendSkippedKey

Definition at line 215 of file deblend.py.

◆ hasStrayFluxKey

lsst.meas.deblender.deblend.SourceDeblendTask.hasStrayFluxKey

Definition at line 228 of file deblend.py.

◆ maskedKey

lsst.meas.deblender.deblend.SourceDeblendTask.maskedKey

Definition at line 208 of file deblend.py.

◆ nChildKey

lsst.meas.deblender.deblend.SourceDeblendTask.nChildKey

Definition at line 195 of file deblend.py.

◆ peakSchemaMapper

lsst.meas.deblender.deblend.SourceDeblendTask.peakSchemaMapper

Definition at line 180 of file deblend.py.

◆ psfCenterKey

lsst.meas.deblender.deblend.SourceDeblendTask.psfCenterKey

Definition at line 199 of file deblend.py.

◆ psfFluxKey

lsst.meas.deblender.deblend.SourceDeblendTask.psfFluxKey

Definition at line 201 of file deblend.py.

◆ psfKey

lsst.meas.deblender.deblend.SourceDeblendTask.psfKey

Definition at line 197 of file deblend.py.

◆ schema

lsst.meas.deblender.deblend.SourceDeblendTask.schema

Definition at line 173 of file deblend.py.

◆ toCopyFromParent

lsst.meas.deblender.deblend.SourceDeblendTask.toCopyFromParent

Definition at line 174 of file deblend.py.

◆ tooBigKey

lsst.meas.deblender.deblend.SourceDeblendTask.tooBigKey

Definition at line 206 of file deblend.py.

◆ tooManyPeaksKey

lsst.meas.deblender.deblend.SourceDeblendTask.tooManyPeaksKey

Definition at line 203 of file deblend.py.


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