Public Member Functions
	__init__ (self, peak, pki, parent, multiColorPeak=None)

	__str__ (self)

	psfFitChisq (self)

	psfFitDof (self)

	getFluxPortion (self, strayFlux=True)

	setStrayFlux (self, stray)

	setFluxPortion (self, mimg)

	setTemplateWeight (self, w)

	setPatched (self)

	setOrigTemplate (self, t, tfoot)

	setRampedTemplate (self, t, tfoot)

	setMedianFilteredTemplate (self, t, tfoot)

	setPsfTemplate (self, tim, tfoot)

	setOutOfBounds (self)

	setTinyFootprint (self)

	setNoValidPixels (self)

	setPsfFitFailed (self)

	setBadPsfDof (self)

	setDeblendedAsPsf (self)

	setFailedSymmetricTemplate (self)

	setTemplate (self, image, footprint)

Public Attributes
	peak = peak

	pki = pki

	parent = parent

	multiColorPeak = multiColorPeak

bool	skip = False

bool	outOfBounds = False

bool	tinyFootprint = False

bool	noValidPixels = False

bool	deblendedAsPsf = False

bool	degenerate = False

bool	psfFitFailed = False

bool	psfFitBadDof = False

	psfFit1 = None

	psfFit2 = None

	psfFit3 = None

bool	psfFitBigDecenter = False

bool	psfFitWithDecenter = False

	psfFitR0 = None

	psfFitR1 = None

	psfFitStampExtent = None

	psfFitCenter = None

	psfFitBest = None

	psfFitParams = None

	psfFitFlux = None

	psfFitNOthers = None

	psfFitDebugPsf0Img = None

	psfFitDebugPsfImg = None

	psfFitDebugPsfDerivImg = None

	psfFitDebugPsfModel = None

bool	failedSymmetricTemplate = False

	templateImage = None

	templateFootprint = None

	fluxPortion = None

	strayFlux = None

bool	hasRampedTemplate = False

bool	patched = False

	origTemplate = None

	origFootprint = None

	rampedTemplate = None

	medianFilteredTemplate = None

float	templateWeight = 1.0

	psfFootprint = afwDet.Footprint(tfoot)

	psfTemplate = tim.Factory(tim, True)

Detailed Description

Result of deblending a single Peak within a parent Footprint.

There is one of these objects for each Peak in the Footprint.

Parameters
----------
peak: `afw.detection.PeakRecord`
    Peak object in a single band from a peak record
pki: `int`
    Index of the peak in `multiColorPeak.parent.peaks`
parent: `DeblendedParent`
    Parent in the same filter that contains the peak
multiColorPeak: `MultiColorPeak`
    Object containing the same peak in multiple bands

Definition at line 256 of file baseline.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.deblender.baseline.DeblendedPeak.__init__	(	self,
		peak,
		pki,
		parent,
		multiColorPeak = None )

Definition at line 272 of file baseline.py.

    def __init__(self, peak, pki, parent, multiColorPeak=None):
        # Peak object
        self.peak = peak
        # int, peak index number
        self.pki = pki
        self.parent = parent
        self.multiColorPeak = multiColorPeak
        # union of all the ways of failing...
        self.skip = False
 
        self.outOfBounds = False
        self.tinyFootprint = False
        self.noValidPixels = False
        self.deblendedAsPsf = False
        self.degenerate = False
 
        # Field set during _fitPsf:
        self.psfFitFailed = False
        self.psfFitBadDof = False
        # (chisq, dof) for PSF fit without decenter
        self.psfFit1 = None
        # (chisq, dof) for PSF fit with decenter
        self.psfFit2 = None
        # (chisq, dof) for PSF fit after applying decenter
        self.psfFit3 = None
        # decentered PSF fit wanted to move the center too much
        self.psfFitBigDecenter = False
        # was the fit with decenter better?
        self.psfFitWithDecenter = False
        #
        self.psfFitR0 = None
        self.psfFitR1 = None
        self.psfFitStampExtent = None
        self.psfFitCenter = None
        self.psfFitBest = None
        self.psfFitParams = None
        self.psfFitFlux = None
        self.psfFitNOthers = None
 
        # Things only set in _fitPsf when debugging is turned on:
        self.psfFitDebugPsf0Img = None
        self.psfFitDebugPsfImg = None
        self.psfFitDebugPsfDerivImg = None
        self.psfFitDebugPsfModel = None
 
        self.failedSymmetricTemplate = False
 
        # The actual template Image and Footprint
        self.templateImage = None
        self.templateFootprint = None
 
        # The flux assigned to this template -- a MaskedImage
        self.fluxPortion = None
 
        # The stray flux assigned to this template (may be None), a HeavyFootprint
        self.strayFlux = None
 
        self.hasRampedTemplate = False
 
        self.patched = False
 
        # debug -- a copy of the original symmetric template
        self.origTemplate = None
        self.origFootprint = None
        # MaskedImage
        self.rampedTemplate = None
        # MaskedImage
        self.medianFilteredTemplate = None
 
        # when least-squares fitting templates, the template weight.
        self.templateWeight = 1.0
 

Member Function Documentation

◆ str()

lsst.meas.deblender.baseline.DeblendedPeak.__str__ ( self )

Definition at line 344 of file baseline.py.

    def __str__(self):
        return (('deblend result: outOfBounds: %s, deblendedAsPsf: %s') %
                (self.outOfBounds, self.deblendedAsPsf))
 

◆ getFluxPortion()

lsst.meas.deblender.baseline.DeblendedPeak.getFluxPortion	(		self,
			strayFlux = True )

Return a HeavyFootprint containing the flux apportioned to this peak.

@param[in]     strayFlux   include stray flux also?

Definition at line 358 of file baseline.py.

    def getFluxPortion(self, strayFlux=True):
        """
        Return a HeavyFootprint containing the flux apportioned to this peak.
 
        @param[in]     strayFlux   include stray flux also?
        """
        if self.templateFootprint is None or self.fluxPortion is None:
            return None
        heavy = afwDet.makeHeavyFootprint(self.templateFootprint, self.fluxPortion)
        if strayFlux:
            if self.strayFlux is not None:
                heavy = afwDet.mergeHeavyFootprints(heavy, self.strayFlux)
 
        return heavy
 

◆ psfFitChisq()

lsst.meas.deblender.baseline.DeblendedPeak.psfFitChisq ( self )

Definition at line 349 of file baseline.py.

    def psfFitChisq(self):
        chisq, dof = self.psfFitBest
        return chisq
 

◆ psfFitDof()

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDof ( self )

Definition at line 354 of file baseline.py.

    def psfFitDof(self):
        chisq, dof = self.psfFitBest
        return dof
 

◆ setBadPsfDof()

lsst.meas.deblender.baseline.DeblendedPeak.setBadPsfDof ( self )

Definition at line 416 of file baseline.py.

    def setBadPsfDof(self):
        self.psfFitBadDof = True
 

◆ setDeblendedAsPsf()

lsst.meas.deblender.baseline.DeblendedPeak.setDeblendedAsPsf ( self )

Definition at line 419 of file baseline.py.

    def setDeblendedAsPsf(self):
        self.deblendedAsPsf = True
 

◆ setFailedSymmetricTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setFailedSymmetricTemplate ( self )

Definition at line 422 of file baseline.py.

    def setFailedSymmetricTemplate(self):
        self.failedSymmetricTemplate = True
        self.skip = True
 

◆ setFluxPortion()

lsst.meas.deblender.baseline.DeblendedPeak.setFluxPortion	(		self,
			mimg )

Definition at line 376 of file baseline.py.

    def setFluxPortion(self, mimg):
        self.fluxPortion = mimg
 

◆ setMedianFilteredTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setMedianFilteredTemplate	(	self,
		t,
		tfoot )

Definition at line 394 of file baseline.py.

    def setMedianFilteredTemplate(self, t, tfoot):
        self.medianFilteredTemplate = t.Factory(t, True)
 

◆ setNoValidPixels()

lsst.meas.deblender.baseline.DeblendedPeak.setNoValidPixels ( self )

Definition at line 409 of file baseline.py.

    def setNoValidPixels(self):
        self.noValidPixels = True
        self.skip = True
 

◆ setOrigTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setOrigTemplate	(	self,
		t,
		tfoot )

Definition at line 386 of file baseline.py.

    def setOrigTemplate(self, t, tfoot):
        self.origTemplate = t.Factory(t, True)
        self.origFootprint = tfoot
 

◆ setOutOfBounds()

lsst.meas.deblender.baseline.DeblendedPeak.setOutOfBounds ( self )

Definition at line 401 of file baseline.py.

    def setOutOfBounds(self):
        self.outOfBounds = True
        self.skip = True
 

◆ setPatched()

lsst.meas.deblender.baseline.DeblendedPeak.setPatched ( self )

Definition at line 382 of file baseline.py.

    def setPatched(self):
        self.patched = True
 

◆ setPsfFitFailed()

lsst.meas.deblender.baseline.DeblendedPeak.setPsfFitFailed ( self )

Definition at line 413 of file baseline.py.

    def setPsfFitFailed(self):
        self.psfFitFailed = True
 

◆ setPsfTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setPsfTemplate	(	self,
		tim,
		tfoot )

Definition at line 397 of file baseline.py.

    def setPsfTemplate(self, tim, tfoot):
        self.psfFootprint = afwDet.Footprint(tfoot)
        self.psfTemplate = tim.Factory(tim, True)
 

◆ setRampedTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setRampedTemplate	(	self,
		t,
		tfoot )

Definition at line 390 of file baseline.py.

    def setRampedTemplate(self, t, tfoot):
        self.hasRampedTemplate = True
        self.rampedTemplate = t.Factory(t, True)
 

◆ setStrayFlux()

lsst.meas.deblender.baseline.DeblendedPeak.setStrayFlux	(		self,
			stray )

Definition at line 373 of file baseline.py.

    def setStrayFlux(self, stray):
        self.strayFlux = stray
 

◆ setTemplate()

lsst.meas.deblender.baseline.DeblendedPeak.setTemplate	(	self,
		image,
		footprint )

Definition at line 426 of file baseline.py.

    def setTemplate(self, image, footprint):
        self.templateImage = image
        self.templateFootprint = footprint
 
 

◆ setTemplateWeight()

lsst.meas.deblender.baseline.DeblendedPeak.setTemplateWeight	(		self,
			w )

Definition at line 379 of file baseline.py.

    def setTemplateWeight(self, w):
        self.templateWeight = w
 

◆ setTinyFootprint()

lsst.meas.deblender.baseline.DeblendedPeak.setTinyFootprint ( self )

Definition at line 405 of file baseline.py.

    def setTinyFootprint(self):
        self.tinyFootprint = True
        self.skip = True
 

Member Data Documentation

◆ deblendedAsPsf

lsst.meas.deblender.baseline.DeblendedPeak.deblendedAsPsf = False

Definition at line 285 of file baseline.py.

◆ degenerate

bool lsst.meas.deblender.baseline.DeblendedPeak.degenerate = False

Definition at line 286 of file baseline.py.

◆ failedSymmetricTemplate

bool lsst.meas.deblender.baseline.DeblendedPeak.failedSymmetricTemplate = False

Definition at line 317 of file baseline.py.

◆ fluxPortion

lsst.meas.deblender.baseline.DeblendedPeak.fluxPortion = None

Definition at line 324 of file baseline.py.

◆ hasRampedTemplate

bool lsst.meas.deblender.baseline.DeblendedPeak.hasRampedTemplate = False

Definition at line 329 of file baseline.py.

◆ medianFilteredTemplate

lsst.meas.deblender.baseline.DeblendedPeak.medianFilteredTemplate = None

Definition at line 339 of file baseline.py.

◆ multiColorPeak

lsst.meas.deblender.baseline.DeblendedPeak.multiColorPeak = multiColorPeak

Definition at line 278 of file baseline.py.

◆ noValidPixels

bool lsst.meas.deblender.baseline.DeblendedPeak.noValidPixels = False

Definition at line 284 of file baseline.py.

◆ origFootprint

lsst.meas.deblender.baseline.DeblendedPeak.origFootprint = None

Definition at line 335 of file baseline.py.

◆ origTemplate

lsst.meas.deblender.baseline.DeblendedPeak.origTemplate = None

Definition at line 334 of file baseline.py.

◆ outOfBounds

lsst.meas.deblender.baseline.DeblendedPeak.outOfBounds = False

Definition at line 282 of file baseline.py.

◆ parent

lsst.meas.deblender.baseline.DeblendedPeak.parent = parent

Definition at line 277 of file baseline.py.

◆ patched

bool lsst.meas.deblender.baseline.DeblendedPeak.patched = False

Definition at line 331 of file baseline.py.

◆ peak

lsst.meas.deblender.baseline.DeblendedPeak.peak = peak

Definition at line 274 of file baseline.py.

◆ pki

lsst.meas.deblender.baseline.DeblendedPeak.pki = pki

Definition at line 276 of file baseline.py.

◆ psfFit1

lsst.meas.deblender.baseline.DeblendedPeak.psfFit1 = None

Definition at line 292 of file baseline.py.

◆ psfFit2

lsst.meas.deblender.baseline.DeblendedPeak.psfFit2 = None

Definition at line 294 of file baseline.py.

◆ psfFit3

lsst.meas.deblender.baseline.DeblendedPeak.psfFit3 = None

Definition at line 296 of file baseline.py.

◆ psfFitBadDof

bool lsst.meas.deblender.baseline.DeblendedPeak.psfFitBadDof = False

Definition at line 290 of file baseline.py.

◆ psfFitBest

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBest = None

Definition at line 306 of file baseline.py.

◆ psfFitBigDecenter

bool lsst.meas.deblender.baseline.DeblendedPeak.psfFitBigDecenter = False

Definition at line 298 of file baseline.py.

◆ psfFitCenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitCenter = None

Definition at line 305 of file baseline.py.

◆ psfFitDebugPsf0Img

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsf0Img = None

Definition at line 312 of file baseline.py.

◆ psfFitDebugPsfDerivImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfDerivImg = None

Definition at line 314 of file baseline.py.

◆ psfFitDebugPsfImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfImg = None

Definition at line 313 of file baseline.py.

◆ psfFitDebugPsfModel

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfModel = None

Definition at line 315 of file baseline.py.

◆ psfFitFailed

bool lsst.meas.deblender.baseline.DeblendedPeak.psfFitFailed = False

Definition at line 289 of file baseline.py.

◆ psfFitFlux

lsst.meas.deblender.baseline.DeblendedPeak.psfFitFlux = None

Definition at line 308 of file baseline.py.

◆ psfFitNOthers

lsst.meas.deblender.baseline.DeblendedPeak.psfFitNOthers = None

Definition at line 309 of file baseline.py.

◆ psfFitParams

lsst.meas.deblender.baseline.DeblendedPeak.psfFitParams = None

Definition at line 307 of file baseline.py.

◆ psfFitR0

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR0 = None

Definition at line 302 of file baseline.py.

◆ psfFitR1

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR1 = None

Definition at line 303 of file baseline.py.

◆ psfFitStampExtent

lsst.meas.deblender.baseline.DeblendedPeak.psfFitStampExtent = None

Definition at line 304 of file baseline.py.

◆ psfFitWithDecenter

bool lsst.meas.deblender.baseline.DeblendedPeak.psfFitWithDecenter = False

Definition at line 300 of file baseline.py.

◆ psfFootprint

lsst.meas.deblender.baseline.DeblendedPeak.psfFootprint = afwDet.Footprint(tfoot)

Definition at line 398 of file baseline.py.

◆ psfTemplate

lsst.meas.deblender.baseline.DeblendedPeak.psfTemplate = tim.Factory(tim, True)

Definition at line 399 of file baseline.py.

◆ rampedTemplate

lsst.meas.deblender.baseline.DeblendedPeak.rampedTemplate = None

Definition at line 337 of file baseline.py.

◆ skip

bool lsst.meas.deblender.baseline.DeblendedPeak.skip = False

Definition at line 280 of file baseline.py.

◆ strayFlux

lsst.meas.deblender.baseline.DeblendedPeak.strayFlux = None

Definition at line 327 of file baseline.py.

◆ templateFootprint

lsst.meas.deblender.baseline.DeblendedPeak.templateFootprint = None

Definition at line 321 of file baseline.py.

◆ templateImage

lsst.meas.deblender.baseline.DeblendedPeak.templateImage = None

Definition at line 320 of file baseline.py.

◆ templateWeight

float lsst.meas.deblender.baseline.DeblendedPeak.templateWeight = 1.0

Definition at line 342 of file baseline.py.

◆ tinyFootprint

bool lsst.meas.deblender.baseline.DeblendedPeak.tinyFootprint = False

Definition at line 283 of file baseline.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/meas_deblender/gb1101e3267+f6b489998a/python/lsst/meas/deblender/baseline.py

Public Member Functions

Public Attributes