lsst.meas.deblender  22.0.1-2-g1cb3e5b+05cc9cec2f
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask Class Reference

More...

Inheritance diagram for lsst.meas.deblender.sourceDeblendTask.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
 
 peakCenter
 
 peakIdKey
 
 nPeaksKey
 
 parentNPeaksKey
 

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 170 of file sourceDeblendTask.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.deblender.sourceDeblendTask.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 181 of file sourceDeblendTask.py.

Member Function Documentation

◆ addSchemaKeys()

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

Definition at line 214 of file sourceDeblendTask.py.

◆ deblend()

def lsst.meas.deblender.sourceDeblendTask.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 291 of file sourceDeblendTask.py.

◆ isLargeFootprint()

def lsst.meas.deblender.sourceDeblendTask.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 495 of file sourceDeblendTask.py.

◆ isMasked()

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

Definition at line 517 of file sourceDeblendTask.py.

◆ postSingleDeblendHook()

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

Definition at line 492 of file sourceDeblendTask.py.

◆ preSingleDeblendHook()

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

Definition at line 489 of file sourceDeblendTask.py.

◆ run()

def lsst.meas.deblender.sourceDeblendTask.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 272 of file sourceDeblendTask.py.

◆ skipParent()

def lsst.meas.deblender.sourceDeblendTask.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 527 of file sourceDeblendTask.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 178 of file sourceDeblendTask.py.

◆ deblendFailedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendFailedKey

Definition at line 232 of file sourceDeblendTask.py.

◆ deblendPatchedTemplateKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendPatchedTemplateKey

Definition at line 243 of file sourceDeblendTask.py.

◆ deblendRampedTemplateKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendRampedTemplateKey

Definition at line 238 of file sourceDeblendTask.py.

◆ deblendSkippedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendSkippedKey

Definition at line 235 of file sourceDeblendTask.py.

◆ hasStrayFluxKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.hasStrayFluxKey

Definition at line 248 of file sourceDeblendTask.py.

◆ maskedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.maskedKey

Definition at line 228 of file sourceDeblendTask.py.

◆ nChildKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.nChildKey

Definition at line 215 of file sourceDeblendTask.py.

◆ nPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.nPeaksKey

Definition at line 263 of file sourceDeblendTask.py.

◆ parentNPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.parentNPeaksKey

Definition at line 267 of file sourceDeblendTask.py.

◆ peakCenter

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakCenter

Definition at line 255 of file sourceDeblendTask.py.

◆ peakIdKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakIdKey

Definition at line 258 of file sourceDeblendTask.py.

◆ peakSchemaMapper

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakSchemaMapper

Definition at line 200 of file sourceDeblendTask.py.

◆ psfCenterKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfCenterKey

Definition at line 219 of file sourceDeblendTask.py.

◆ psfFluxKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfFluxKey

Definition at line 221 of file sourceDeblendTask.py.

◆ psfKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfKey

Definition at line 217 of file sourceDeblendTask.py.

◆ schema

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.schema

Definition at line 193 of file sourceDeblendTask.py.

◆ toCopyFromParent

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.toCopyFromParent

Definition at line 194 of file sourceDeblendTask.py.

◆ tooBigKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.tooBigKey

Definition at line 226 of file sourceDeblendTask.py.

◆ tooManyPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.tooManyPeaksKey

Definition at line 223 of file sourceDeblendTask.py.


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