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

def	__str__ (self)

def	psfFitChisq (self)

def	psfFitDof (self)

def	getFluxPortion (self, strayFlux=True)
	Return a HeavyFootprint containing the flux apportioned to this peak. More...

def	setStrayFlux (self, stray)

def	setFluxPortion (self, mimg)

def	setTemplateWeight (self, w)

def	setPatched (self)

def	setOrigTemplate (self, t, tfoot)

def	setRampedTemplate (self, t, tfoot)

def	setMedianFilteredTemplate (self, t, tfoot)

def	setPsfTemplate (self, tim, tfoot)

def	setOutOfBounds (self)

def	setTinyFootprint (self)

def	setNoValidPixels (self)

def	setPsfFitFailed (self)

def	setBadPsfDof (self)

def	setDeblendedAsPsf (self)

def	setFailedSymmetricTemplate (self)

def	setTemplate (self, image, footprint)

Detailed Description

Result of deblending a single Peak within a parent Footprint.

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

Definition at line 266 of file baseline.py.

Constructor & Destructor Documentation

◆ init()

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

Initialize a new deblended peak in a single filter band

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

Returns
-------
None

Definition at line 272 of file baseline.py.

     def __init__(self, peak, pki, parent, multiColorPeak=None):
         """Initialize a new deblended peak in a single filter band
  
         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
  
         Returns
         -------
         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()

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

Definition at line 361 of file baseline.py.

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

◆ getFluxPortion()

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

Return a HeavyFootprint containing the flux apportioned to this peak.

Parameters

[in] strayFlux include stray flux also?

Definition at line 375 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()

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

Definition at line 366 of file baseline.py.

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

◆ psfFitDof()

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

Definition at line 371 of file baseline.py.

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

◆ setBadPsfDof()

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

Definition at line 433 of file baseline.py.

     def setBadPsfDof(self):
         self.psfFitBadDof = True
  

◆ setDeblendedAsPsf()

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

Definition at line 436 of file baseline.py.

     def setDeblendedAsPsf(self):
         self.deblendedAsPsf = True
  

◆ setFailedSymmetricTemplate()

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

Definition at line 439 of file baseline.py.

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

◆ setFluxPortion()

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

Definition at line 393 of file baseline.py.

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

◆ setMedianFilteredTemplate()

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

Definition at line 411 of file baseline.py.

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

◆ setNoValidPixels()

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

Definition at line 426 of file baseline.py.

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

◆ setOrigTemplate()

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

Definition at line 403 of file baseline.py.

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

◆ setOutOfBounds()

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

Definition at line 418 of file baseline.py.

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

◆ setPatched()

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

Definition at line 399 of file baseline.py.

     def setPatched(self):
         self.patched = True
  

◆ setPsfFitFailed()

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

Definition at line 430 of file baseline.py.

     def setPsfFitFailed(self):
         self.psfFitFailed = True
  

◆ setPsfTemplate()

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

Definition at line 414 of file baseline.py.

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

◆ setRampedTemplate()

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

Definition at line 407 of file baseline.py.

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

◆ setStrayFlux()

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

Definition at line 390 of file baseline.py.

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

◆ setTemplate()

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

Definition at line 443 of file baseline.py.

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

◆ setTemplateWeight()

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

Definition at line 396 of file baseline.py.

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

◆ setTinyFootprint()

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

Definition at line 422 of file baseline.py.

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

Member Data Documentation

◆ deblendedAsPsf

lsst.meas.deblender.baseline.DeblendedPeak.deblendedAsPsf

Definition at line 302 of file baseline.py.

◆ degenerate

lsst.meas.deblender.baseline.DeblendedPeak.degenerate

Definition at line 303 of file baseline.py.

◆ failedSymmetricTemplate

lsst.meas.deblender.baseline.DeblendedPeak.failedSymmetricTemplate

Definition at line 334 of file baseline.py.

◆ fluxPortion

lsst.meas.deblender.baseline.DeblendedPeak.fluxPortion

Definition at line 341 of file baseline.py.

◆ hasRampedTemplate

lsst.meas.deblender.baseline.DeblendedPeak.hasRampedTemplate

Definition at line 346 of file baseline.py.

◆ medianFilteredTemplate

lsst.meas.deblender.baseline.DeblendedPeak.medianFilteredTemplate

Definition at line 356 of file baseline.py.

◆ multiColorPeak

lsst.meas.deblender.baseline.DeblendedPeak.multiColorPeak

Definition at line 295 of file baseline.py.

◆ noValidPixels

lsst.meas.deblender.baseline.DeblendedPeak.noValidPixels

Definition at line 301 of file baseline.py.

◆ origFootprint

lsst.meas.deblender.baseline.DeblendedPeak.origFootprint

Definition at line 352 of file baseline.py.

◆ origTemplate

lsst.meas.deblender.baseline.DeblendedPeak.origTemplate

Definition at line 351 of file baseline.py.

◆ outOfBounds

lsst.meas.deblender.baseline.DeblendedPeak.outOfBounds

Definition at line 299 of file baseline.py.

◆ parent

lsst.meas.deblender.baseline.DeblendedPeak.parent

Definition at line 294 of file baseline.py.

◆ patched

lsst.meas.deblender.baseline.DeblendedPeak.patched

Definition at line 348 of file baseline.py.

◆ peak

lsst.meas.deblender.baseline.DeblendedPeak.peak

Definition at line 291 of file baseline.py.

◆ pki

lsst.meas.deblender.baseline.DeblendedPeak.pki

Definition at line 293 of file baseline.py.

◆ psfFit1

lsst.meas.deblender.baseline.DeblendedPeak.psfFit1

Definition at line 309 of file baseline.py.

◆ psfFit2

lsst.meas.deblender.baseline.DeblendedPeak.psfFit2

Definition at line 311 of file baseline.py.

◆ psfFit3

lsst.meas.deblender.baseline.DeblendedPeak.psfFit3

Definition at line 313 of file baseline.py.

◆ psfFitBadDof

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBadDof

Definition at line 307 of file baseline.py.

◆ psfFitBest

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBest

Definition at line 323 of file baseline.py.

◆ psfFitBigDecenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBigDecenter

Definition at line 315 of file baseline.py.

◆ psfFitCenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitCenter

Definition at line 322 of file baseline.py.

◆ psfFitDebugPsf0Img

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsf0Img

Definition at line 329 of file baseline.py.

◆ psfFitDebugPsfDerivImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfDerivImg

Definition at line 331 of file baseline.py.

◆ psfFitDebugPsfImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfImg

Definition at line 330 of file baseline.py.

◆ psfFitDebugPsfModel

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfModel

Definition at line 332 of file baseline.py.

◆ psfFitFailed

lsst.meas.deblender.baseline.DeblendedPeak.psfFitFailed

Definition at line 306 of file baseline.py.

◆ psfFitFlux

lsst.meas.deblender.baseline.DeblendedPeak.psfFitFlux

Definition at line 325 of file baseline.py.

◆ psfFitNOthers

lsst.meas.deblender.baseline.DeblendedPeak.psfFitNOthers

Definition at line 326 of file baseline.py.

◆ psfFitParams

lsst.meas.deblender.baseline.DeblendedPeak.psfFitParams

Definition at line 324 of file baseline.py.

◆ psfFitR0

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR0

Definition at line 319 of file baseline.py.

◆ psfFitR1

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR1

Definition at line 320 of file baseline.py.

◆ psfFitStampExtent

lsst.meas.deblender.baseline.DeblendedPeak.psfFitStampExtent

Definition at line 321 of file baseline.py.

◆ psfFitWithDecenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitWithDecenter

Definition at line 317 of file baseline.py.

◆ psfFootprint

lsst.meas.deblender.baseline.DeblendedPeak.psfFootprint

Definition at line 415 of file baseline.py.

◆ psfTemplate

lsst.meas.deblender.baseline.DeblendedPeak.psfTemplate

Definition at line 416 of file baseline.py.

◆ rampedTemplate

lsst.meas.deblender.baseline.DeblendedPeak.rampedTemplate

Definition at line 354 of file baseline.py.

◆ skip

lsst.meas.deblender.baseline.DeblendedPeak.skip

Definition at line 297 of file baseline.py.

◆ strayFlux

lsst.meas.deblender.baseline.DeblendedPeak.strayFlux

Definition at line 344 of file baseline.py.

◆ templateFootprint

lsst.meas.deblender.baseline.DeblendedPeak.templateFootprint

Definition at line 338 of file baseline.py.

◆ templateImage

lsst.meas.deblender.baseline.DeblendedPeak.templateImage

Definition at line 337 of file baseline.py.

◆ templateWeight

lsst.meas.deblender.baseline.DeblendedPeak.templateWeight

Definition at line 359 of file baseline.py.

◆ tinyFootprint

lsst.meas.deblender.baseline.DeblendedPeak.tinyFootprint

Definition at line 300 of file baseline.py.

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

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/meas_deblender/20.0.0-3-g8f21e14+4fd2c12c9a/python/lsst/meas/deblender/baseline.py

Public Attributes
	peak

	pki

	parent

	multiColorPeak

	skip

	outOfBounds

	tinyFootprint

	noValidPixels

	deblendedAsPsf

	degenerate

	psfFitFailed

	psfFitBadDof

	psfFit1

	psfFit2

	psfFit3

	psfFitBigDecenter

	psfFitWithDecenter

	psfFitR0

	psfFitR1

	psfFitStampExtent

	psfFitCenter

	psfFitBest

	psfFitParams

	psfFitFlux

	psfFitNOthers

	psfFitDebugPsf0Img

	psfFitDebugPsfImg

	psfFitDebugPsfDerivImg

	psfFitDebugPsfModel

	failedSymmetricTemplate

	templateImage

	templateFootprint

	fluxPortion

	strayFlux

	hasRampedTemplate

	patched

	origTemplate

	origFootprint

	rampedTemplate

	medianFilteredTemplate

	templateWeight

	psfFootprint

	psfTemplate

Public Member Functions

Public Attributes