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

Public Member Functions
	__init__ (self, schema, peakSchema=None, **kwargs)
	addSchemaKeys (self, schema)
	run (self, exposure, sources)
	deblend (self, exposure, srcs, psf)
	preSingleDeblendHook (self, exposure, srcs, i, fp, psf, psf_fwhm, sigma1)
	postSingleDeblendHook (self, exposure, srcs, i, npre, kids, fp, psf, psf_fwhm, sigma1, res)
	isLargeFootprint (self, footprint)
	isMasked (self, footprint, mask)
	skipParent (self, source, mask)

Public Attributes
	schema = schema
list	toCopyFromParent
	peakSchemaMapper = afwTable.SchemaMapper(peakMinimalSchema, schema)
	nChildKey
	psfKey
	psfCenterKey
	psfFluxKey
	tooManyPeaksKey
	tooBigKey
	maskedKey
	deblendFailedKey
	deblendSkippedKey
	deblendRampedTemplateKey
	deblendPatchedTemplateKey
	hasStrayFluxKey
	peakCenter
	peakIdKey
	nPeaksKey
	parentNPeaksKey

Static Public Attributes
	ConfigClass = SourceDeblendConfig

Protected Member Functions
	_getPsfFwhm (self, psf, position)

Static Protected Attributes
str	_DefaultName = "sourceDeblend"

Detailed Description

Split blended sources into individual sources.

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

Definition at line 164 of file sourceDeblendTask.py.

Constructor & Destructor Documentation

◆ init()

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

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

Parameters
----------
schema : `lsst.afw.table.Schema`
    Schema object for measurement fields; will be modified in-place.
peakSchema : `lsst.afw.table.peakSchema`
    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
**kwargs
    Additional keyword arguments passed to ~lsst.pipe.base.task

Definition at line 172 of file sourceDeblendTask.py.

Member Function Documentation

◆ _getPsfFwhm()

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask._getPsfFwhm	(	self,
		psf,
		position )

protected

Definition at line 281 of file sourceDeblendTask.py.

◆ addSchemaKeys()

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

Definition at line 209 of file sourceDeblendTask.py.

◆ deblend()

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

Deblend.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to be processed
srcs : `lsst.afw.table.SourceCatalog`
    SourceCatalog containing sources detected on this exposure
psf : `lsst.afw.detection.Psf`
    Point source function

Returns
-------
None

Definition at line 285 of file sourceDeblendTask.py.

◆ isLargeFootprint()

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

◆ isMasked()

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.isMasked	(	self,
		footprint,
		mask )

Returns whether the footprint violates the mask limits

Definition at line 528 of file sourceDeblendTask.py.

◆ postSingleDeblendHook()

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

Definition at line 503 of file sourceDeblendTask.py.

◆ preSingleDeblendHook()

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

Definition at line 500 of file sourceDeblendTask.py.

◆ run()

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

Get the PSF from the provided exposure and then run deblend.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to be processed
sources : `lsst.afw.table.SourceCatalog`
    SourceCatalog containing sources detected on this exposure.

Definition at line 267 of file sourceDeblendTask.py.

◆ skipParent()

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.

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    The source to flag as skipped
mask : `lsst.afw.image.Mask`
    The mask to update

Definition at line 539 of file sourceDeblendTask.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask._DefaultName = "sourceDeblend"

staticprotected

Definition at line 170 of file sourceDeblendTask.py.

◆ ConfigClass

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

static

Definition at line 169 of file sourceDeblendTask.py.

◆ deblendFailedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendFailedKey

Initial value:

= schema.addField('deblend_failed', type='Flag',

doc="Deblending failed on source")

Definition at line 227 of file sourceDeblendTask.py.

◆ deblendPatchedTemplateKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendPatchedTemplateKey

Initial value:

=  schema.addField(
            'deblend_patchedTemplate', type='Flag',
            doc=('This source was near an image edge and the deblender used '
                 '"patched" edge-handling.'))

Definition at line 238 of file sourceDeblendTask.py.

◆ deblendRampedTemplateKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendRampedTemplateKey

Initial value:

=  schema.addField(
            'deblend_rampedTemplate', type='Flag',
            doc=('This source was near an image edge and the deblender used '
                 '"ramp" edge-handling.'))

Definition at line 233 of file sourceDeblendTask.py.

◆ deblendSkippedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.deblendSkippedKey

Initial value:

= schema.addField('deblend_skipped', type='Flag',

doc="Deblender skipped this source")

Definition at line 230 of file sourceDeblendTask.py.

◆ hasStrayFluxKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.hasStrayFluxKey

Initial value:

=  schema.addField(
            'deblend_hasStrayFlux', type='Flag',
            doc=('This source was assigned some stray flux'))

Definition at line 243 of file sourceDeblendTask.py.

◆ maskedKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.maskedKey

Initial value:

= schema.addField('deblend_masked', type='Flag',

doc='Parent footprint was predominantly masked')

Definition at line 223 of file sourceDeblendTask.py.

◆ nChildKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.nChildKey

Initial value:

= schema.addField('deblend_nChild', type=np.int32,

doc='Number of children this object has (defaults to 0)')

Definition at line 210 of file sourceDeblendTask.py.

◆ nPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.nPeaksKey

Initial value:

=  schema.addField("deblend_nPeaks", type=np.int32,
                                         doc="Number of initial peaks in the blend. "
                                             "This includes peaks that may have been culled "
                                             "during deblending or failed to deblend")

Definition at line 258 of file sourceDeblendTask.py.

◆ parentNPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.parentNPeaksKey

Initial value:

=  schema.addField("deblend_parentNPeaks", type=np.int32,
                                               doc="Same as deblend_n_peaks, but the number of peaks "
                                                   "in the parent footprint")

Definition at line 262 of file sourceDeblendTask.py.

◆ peakCenter

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakCenter

Initial value:

=  afwTable.Point2IKey.addFields(schema, name="deblend_peak_center",
                                                        doc="Center used to apply constraints in scarlet",
                                                        unit="pixel")

Definition at line 250 of file sourceDeblendTask.py.

◆ peakIdKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakIdKey

Initial value:

=  schema.addField("deblend_peakId", type=np.int32,
                                         doc="ID of the peak in the parent footprint. "
                                             "This is not unique, but the combination of 'parent'"
                                             "and 'peakId' should be for all child sources. "
                                             "Top level blends with no parents have 'peakId=0'")

Definition at line 253 of file sourceDeblendTask.py.

◆ peakSchemaMapper

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.peakSchemaMapper = afwTable.SchemaMapper(peakMinimalSchema, schema)

Definition at line 195 of file sourceDeblendTask.py.

◆ psfCenterKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfCenterKey

Initial value:

= afwTable.Point2DKey.addFields(schema, 'deblend_psfCenter',

'If deblended-as-psf, the PSF centroid', "pixel")

Definition at line 214 of file sourceDeblendTask.py.

◆ psfFluxKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfFluxKey

Initial value:

= schema.addField('deblend_psf_instFlux', type='D',

doc='If deblended-as-psf, the instrumental PSF flux', units='count')

Definition at line 216 of file sourceDeblendTask.py.

◆ psfKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.psfKey

Initial value:

= schema.addField('deblend_deblendedAsPsf', type='Flag',

doc='Deblender thought this source looked like a PSF')

Definition at line 212 of file sourceDeblendTask.py.

◆ schema

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.schema = schema

Definition at line 188 of file sourceDeblendTask.py.

◆ toCopyFromParent

list lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.toCopyFromParent

Initial value:

= [item.key for item in self.schema

if item.field.getName().startswith("merge_footprint")]

Definition at line 189 of file sourceDeblendTask.py.

◆ tooBigKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.tooBigKey

Initial value:

= schema.addField('deblend_parentTooBig', type='Flag',

doc='Parent footprint covered too many pixels')

Definition at line 221 of file sourceDeblendTask.py.

◆ tooManyPeaksKey

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask.tooManyPeaksKey

Initial value:

=  schema.addField('deblend_tooManyPeaks', type='Flag',
                                               doc='Source had too many peaks; '
                                               'only the brightest were included')

Definition at line 218 of file sourceDeblendTask.py.

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

python/lsst/meas/deblender/sourceDeblendTask.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _getPsfFwhm()

◆ addSchemaKeys()

◆ deblend()

◆ isLargeFootprint()

◆ isMasked()

◆ postSingleDeblendHook()

◆ preSingleDeblendHook()

◆ run()

◆ skipParent()

Member Data Documentation

◆ _DefaultName

◆ ConfigClass

◆ deblendFailedKey

◆ deblendPatchedTemplateKey

◆ deblendRampedTemplateKey

◆ deblendSkippedKey

◆ hasStrayFluxKey

◆ maskedKey

◆ nChildKey

◆ nPeaksKey

◆ parentNPeaksKey

◆ peakCenter

◆ peakIdKey

◆ peakSchemaMapper

◆ psfCenterKey

◆ psfFluxKey

◆ psfKey

◆ schema

◆ toCopyFromParent

◆ tooBigKey

◆ tooManyPeaksKey

◆ init()