LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Public Attributes | List of all members
lsst.meas.deblender.baseline.DeblendedPeak Class Reference

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)
 
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)
 

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
 

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 255 of file baseline.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 271 of file baseline.py.

271  def __init__(self, peak, pki, parent, multiColorPeak=None):
272  # Peak object
273  self.peak = peak
274  # int, peak index number
275  self.pki = pki
276  self.parent = parent
277  self.multiColorPeak = multiColorPeak
278  # union of all the ways of failing...
279  self.skip = False
280 
281  self.outOfBounds = False
282  self.tinyFootprint = False
283  self.noValidPixels = False
284  self.deblendedAsPsf = False
285  self.degenerate = False
286 
287  # Field set during _fitPsf:
288  self.psfFitFailed = False
289  self.psfFitBadDof = False
290  # (chisq, dof) for PSF fit without decenter
291  self.psfFit1 = None
292  # (chisq, dof) for PSF fit with decenter
293  self.psfFit2 = None
294  # (chisq, dof) for PSF fit after applying decenter
295  self.psfFit3 = None
296  # decentered PSF fit wanted to move the center too much
297  self.psfFitBigDecenter = False
298  # was the fit with decenter better?
299  self.psfFitWithDecenter = False
300  #
301  self.psfFitR0 = None
302  self.psfFitR1 = None
303  self.psfFitStampExtent = None
304  self.psfFitCenter = None
305  self.psfFitBest = None
306  self.psfFitParams = None
307  self.psfFitFlux = None
308  self.psfFitNOthers = None
309 
310  # Things only set in _fitPsf when debugging is turned on:
311  self.psfFitDebugPsf0Img = None
312  self.psfFitDebugPsfImg = None
313  self.psfFitDebugPsfDerivImg = None
314  self.psfFitDebugPsfModel = None
315 
316  self.failedSymmetricTemplate = False
317 
318  # The actual template Image and Footprint
319  self.templateImage = None
320  self.templateFootprint = None
321 
322  # The flux assigned to this template -- a MaskedImage
323  self.fluxPortion = None
324 
325  # The stray flux assigned to this template (may be None), a HeavyFootprint
326  self.strayFlux = None
327 
328  self.hasRampedTemplate = False
329 
330  self.patched = False
331 
332  # debug -- a copy of the original symmetric template
333  self.origTemplate = None
334  self.origFootprint = None
335  # MaskedImage
336  self.rampedTemplate = None
337  # MaskedImage
338  self.medianFilteredTemplate = None
339 
340  # when least-squares fitting templates, the template weight.
341  self.templateWeight = 1.0
342 

Member Function Documentation

◆ __str__()

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

Definition at line 343 of file baseline.py.

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

◆ getFluxPortion()

def 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 357 of file baseline.py.

357  def getFluxPortion(self, strayFlux=True):
358  """
359  Return a HeavyFootprint containing the flux apportioned to this peak.
360 
361  @param[in] strayFlux include stray flux also?
362  """
363  if self.templateFootprint is None or self.fluxPortion is None:
364  return None
365  heavy = afwDet.makeHeavyFootprint(self.templateFootprint, self.fluxPortion)
366  if strayFlux:
367  if self.strayFlux is not None:
368  heavy = afwDet.mergeHeavyFootprints(heavy, self.strayFlux)
369 
370  return heavy
371 
lsst::afw::detection::mergeHeavyFootprints
std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > mergeHeavyFootprints(HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h1, HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h2)
Sum the two given HeavyFootprints h1 and h2, returning a HeavyFootprint with the union footprint,...
Definition: HeavyFootprint.cc:128
lsst::afw::detection::makeHeavyFootprint
HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > makeHeavyFootprint(Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &img, HeavyFootprintCtrl const *ctrl=nullptr)
Create a HeavyFootprint with footprint defined by the given Footprint and pixel values from the given...
Definition: HeavyFootprint.h:148

◆ psfFitChisq()

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

Definition at line 348 of file baseline.py.

348  def psfFitChisq(self):
349  chisq, dof = self.psfFitBest
350  return chisq
351 

◆ psfFitDof()

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

Definition at line 353 of file baseline.py.

353  def psfFitDof(self):
354  chisq, dof = self.psfFitBest
355  return dof
356 

◆ setBadPsfDof()

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

Definition at line 415 of file baseline.py.

415  def setBadPsfDof(self):
416  self.psfFitBadDof = True
417 

◆ setDeblendedAsPsf()

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

Definition at line 418 of file baseline.py.

418  def setDeblendedAsPsf(self):
419  self.deblendedAsPsf = True
420 

◆ setFailedSymmetricTemplate()

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

Definition at line 421 of file baseline.py.

421  def setFailedSymmetricTemplate(self):
422  self.failedSymmetricTemplate = True
423  self.skip = True
424 

◆ setFluxPortion()

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

Definition at line 375 of file baseline.py.

375  def setFluxPortion(self, mimg):
376  self.fluxPortion = mimg
377 

◆ setMedianFilteredTemplate()

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

Definition at line 393 of file baseline.py.

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

◆ setNoValidPixels()

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

Definition at line 408 of file baseline.py.

408  def setNoValidPixels(self):
409  self.noValidPixels = True
410  self.skip = True
411 

◆ setOrigTemplate()

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

Definition at line 385 of file baseline.py.

385  def setOrigTemplate(self, t, tfoot):
386  self.origTemplate = t.Factory(t, True)
387  self.origFootprint = tfoot
388 

◆ setOutOfBounds()

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

Definition at line 400 of file baseline.py.

400  def setOutOfBounds(self):
401  self.outOfBounds = True
402  self.skip = True
403 

◆ setPatched()

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

Definition at line 381 of file baseline.py.

381  def setPatched(self):
382  self.patched = True
383 

◆ setPsfFitFailed()

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

Definition at line 412 of file baseline.py.

412  def setPsfFitFailed(self):
413  self.psfFitFailed = True
414 

◆ setPsfTemplate()

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

Definition at line 396 of file baseline.py.

396  def setPsfTemplate(self, tim, tfoot):
397  self.psfFootprint = afwDet.Footprint(tfoot)
398  self.psfTemplate = tim.Factory(tim, True)
399 
lsst::afw::detection::Footprint
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63

◆ setRampedTemplate()

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

Definition at line 389 of file baseline.py.

389  def setRampedTemplate(self, t, tfoot):
390  self.hasRampedTemplate = True
391  self.rampedTemplate = t.Factory(t, True)
392 

◆ setStrayFlux()

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

Definition at line 372 of file baseline.py.

372  def setStrayFlux(self, stray):
373  self.strayFlux = stray
374 

◆ setTemplate()

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

Definition at line 425 of file baseline.py.

425  def setTemplate(self, image, footprint):
426  self.templateImage = image
427  self.templateFootprint = footprint
428 
429 

◆ setTemplateWeight()

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

Definition at line 378 of file baseline.py.

378  def setTemplateWeight(self, w):
379  self.templateWeight = w
380 

◆ setTinyFootprint()

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

Definition at line 404 of file baseline.py.

404  def setTinyFootprint(self):
405  self.tinyFootprint = True
406  self.skip = True
407 

Member Data Documentation

◆ deblendedAsPsf

lsst.meas.deblender.baseline.DeblendedPeak.deblendedAsPsf

Definition at line 284 of file baseline.py.

◆ degenerate

lsst.meas.deblender.baseline.DeblendedPeak.degenerate

Definition at line 285 of file baseline.py.

◆ failedSymmetricTemplate

lsst.meas.deblender.baseline.DeblendedPeak.failedSymmetricTemplate

Definition at line 316 of file baseline.py.

◆ fluxPortion

lsst.meas.deblender.baseline.DeblendedPeak.fluxPortion

Definition at line 323 of file baseline.py.

◆ hasRampedTemplate

lsst.meas.deblender.baseline.DeblendedPeak.hasRampedTemplate

Definition at line 328 of file baseline.py.

◆ medianFilteredTemplate

lsst.meas.deblender.baseline.DeblendedPeak.medianFilteredTemplate

Definition at line 338 of file baseline.py.

◆ multiColorPeak

lsst.meas.deblender.baseline.DeblendedPeak.multiColorPeak

Definition at line 277 of file baseline.py.

◆ noValidPixels

lsst.meas.deblender.baseline.DeblendedPeak.noValidPixels

Definition at line 283 of file baseline.py.

◆ origFootprint

lsst.meas.deblender.baseline.DeblendedPeak.origFootprint

Definition at line 334 of file baseline.py.

◆ origTemplate

lsst.meas.deblender.baseline.DeblendedPeak.origTemplate

Definition at line 333 of file baseline.py.

◆ outOfBounds

lsst.meas.deblender.baseline.DeblendedPeak.outOfBounds

Definition at line 281 of file baseline.py.

◆ parent

lsst.meas.deblender.baseline.DeblendedPeak.parent

Definition at line 276 of file baseline.py.

◆ patched

lsst.meas.deblender.baseline.DeblendedPeak.patched

Definition at line 330 of file baseline.py.

◆ peak

lsst.meas.deblender.baseline.DeblendedPeak.peak

Definition at line 273 of file baseline.py.

◆ pki

lsst.meas.deblender.baseline.DeblendedPeak.pki

Definition at line 275 of file baseline.py.

◆ psfFit1

lsst.meas.deblender.baseline.DeblendedPeak.psfFit1

Definition at line 291 of file baseline.py.

◆ psfFit2

lsst.meas.deblender.baseline.DeblendedPeak.psfFit2

Definition at line 293 of file baseline.py.

◆ psfFit3

lsst.meas.deblender.baseline.DeblendedPeak.psfFit3

Definition at line 295 of file baseline.py.

◆ psfFitBadDof

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBadDof

Definition at line 289 of file baseline.py.

◆ psfFitBest

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBest

Definition at line 305 of file baseline.py.

◆ psfFitBigDecenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitBigDecenter

Definition at line 297 of file baseline.py.

◆ psfFitCenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitCenter

Definition at line 304 of file baseline.py.

◆ psfFitDebugPsf0Img

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsf0Img

Definition at line 311 of file baseline.py.

◆ psfFitDebugPsfDerivImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfDerivImg

Definition at line 313 of file baseline.py.

◆ psfFitDebugPsfImg

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfImg

Definition at line 312 of file baseline.py.

◆ psfFitDebugPsfModel

lsst.meas.deblender.baseline.DeblendedPeak.psfFitDebugPsfModel

Definition at line 314 of file baseline.py.

◆ psfFitFailed

lsst.meas.deblender.baseline.DeblendedPeak.psfFitFailed

Definition at line 288 of file baseline.py.

◆ psfFitFlux

lsst.meas.deblender.baseline.DeblendedPeak.psfFitFlux

Definition at line 307 of file baseline.py.

◆ psfFitNOthers

lsst.meas.deblender.baseline.DeblendedPeak.psfFitNOthers

Definition at line 308 of file baseline.py.

◆ psfFitParams

lsst.meas.deblender.baseline.DeblendedPeak.psfFitParams

Definition at line 306 of file baseline.py.

◆ psfFitR0

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR0

Definition at line 301 of file baseline.py.

◆ psfFitR1

lsst.meas.deblender.baseline.DeblendedPeak.psfFitR1

Definition at line 302 of file baseline.py.

◆ psfFitStampExtent

lsst.meas.deblender.baseline.DeblendedPeak.psfFitStampExtent

Definition at line 303 of file baseline.py.

◆ psfFitWithDecenter

lsst.meas.deblender.baseline.DeblendedPeak.psfFitWithDecenter

Definition at line 299 of file baseline.py.

◆ psfFootprint

lsst.meas.deblender.baseline.DeblendedPeak.psfFootprint

Definition at line 397 of file baseline.py.

◆ psfTemplate

lsst.meas.deblender.baseline.DeblendedPeak.psfTemplate

Definition at line 398 of file baseline.py.

◆ rampedTemplate

lsst.meas.deblender.baseline.DeblendedPeak.rampedTemplate

Definition at line 336 of file baseline.py.

◆ skip

lsst.meas.deblender.baseline.DeblendedPeak.skip

Definition at line 279 of file baseline.py.

◆ strayFlux

lsst.meas.deblender.baseline.DeblendedPeak.strayFlux

Definition at line 326 of file baseline.py.

◆ templateFootprint

lsst.meas.deblender.baseline.DeblendedPeak.templateFootprint

Definition at line 320 of file baseline.py.

◆ templateImage

lsst.meas.deblender.baseline.DeblendedPeak.templateImage

Definition at line 319 of file baseline.py.

◆ templateWeight

lsst.meas.deblender.baseline.DeblendedPeak.templateWeight

Definition at line 341 of file baseline.py.

◆ tinyFootprint

lsst.meas.deblender.baseline.DeblendedPeak.tinyFootprint

Definition at line 282 of file baseline.py.

The documentation for this class was generated from the following file:
Generated on Fri Nov 26 2021 10:16:25 for LSST Applications by doxygen 1.9.1