LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.meas.deblender.baseline.DeblenderResult Class Reference

Public Member Functions

 __init__ (self, footprint, mMaskedImage, psfs, psffwhms, log, maxNumberOfPeaks=0, avgNoise=None)
 
 getParentProperty (self, propertyName)
 
 setTemplateSums (self, templateSums, fidx=None)
 

Public Attributes

 filters
 
 log
 
 mMaskedImage
 
 footprint
 
 psfs
 
 peakCount
 
 deblendedParents
 
 peaks
 
 blend
 
 failed
 

Detailed Description

Collection of objects in multiple bands for a single parent footprint.

Parameters
----------
footprint: `afw.detection.Footprint`
    Parent footprint to deblend. While `maskedImages`, `psfs`,
    and `psffwhms` are lists of objects, one for each band,
    `footprint` is a single parent footprint (from a `mergedDet`)
    this is used for all bands.
mMaskedImage: `MaskedImage`\ s or `MultibandMaskedImage`
    Masked image containing the ``footprint`` in each band.
psfs: list of `afw.detection.Psf`s
    Psf of the ``maskedImage`` for each band.
psffwhm: list of `float`s
    FWHM of the ``maskedImage``'s ``psf`` in each band.
maxNumberOfPeaks: `int`, optional
    If positive, the maximum number of peaks to deblend.
    If the total number of peaks is greater than ``maxNumberOfPeaks``,
    then only the first ``maxNumberOfPeaks`` sources are deblended.
    The default is 0, which deblends all of the peaks.
avgNoise: `float`or list of `float`s, optional
    Average noise level in each ``maskedImage``.
    The default is ``None``, which estimates the noise from the median value of the
    variance plane of ``maskedImage`` for each filter.

Definition at line 47 of file baseline.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.deblender.baseline.DeblenderResult.__init__ ( self,
footprint,
mMaskedImage,
psfs,
psffwhms,
log,
maxNumberOfPeaks = 0,
avgNoise = None )

Definition at line 74 of file baseline.py.

75 maxNumberOfPeaks=0, avgNoise=None):
76 # Check if this is collection of footprints in multiple bands or a single footprint
77 if not isinstance(mMaskedImage, afwImage.MultibandMaskedImage):
78 mMaskedImage = [mMaskedImage]
79 self.filters = [0]
80 else:
81 self.filters = mMaskedImage.filters
82 try:
83 len(psfs)
84 except TypeError:
85 psfs = [psfs]
86 try:
87 len(psffwhms)
88 except TypeError:
89 psffwhms = [psffwhms]
90 try:
91 len(avgNoise)
92 except TypeError:
93 if avgNoise is None:
94 avgNoise = [None]*len(psfs)
95 else:
96 avgNoise = [avgNoise]
97 # Now check that all of the parameters have the same number of entries
98 if any([len(self.filters) != len(p) for p in [psfs, psffwhms, avgNoise]]):
99 raise ValueError("To use the multi-color deblender, "
100 "'maskedImage', 'psf', 'psffwhm', 'avgNoise'"
101 "must have the same length, but instead have lengths: "
102 "{0}".format([len(p) for p in [mMaskedImage,
103 psfs,
104 psffwhms,
105 avgNoise]]))
106
107 self.log = log
108 self.mMaskedImage = mMaskedImage
109 self.footprint = footprint
110 self.psfs = psfs
111
112 self.peakCount = len(footprint.getPeaks())
113 if maxNumberOfPeaks > 0 and maxNumberOfPeaks < self.peakCount:
114 self.peakCount = maxNumberOfPeaks
115
116 # Create a DeblendedParent for the Footprint in every filter
117 self.deblendedParents = OrderedDict([])
118 for n, f in enumerate(self.filters):
119 f = self.filters[n]
120 dp = DeblendedParent(f, footprint, mMaskedImage[f], psfs[n],
121 psffwhms[n], avgNoise[n], maxNumberOfPeaks, self)
122 self.deblendedParents[self.filters[n]] = dp
123
124 # Group the peaks in each color
125 self.peaks = []
126 for idx in range(self.peakCount):
127 peakDict = OrderedDict([(f, dp.peaks[idx]) for f, dp in self.deblendedParents.items()])
128 multiPeak = MultiColorPeak(peakDict, idx, self)
129 self.peaks.append(multiPeak)
130
131 # Result from multiband debender (if used)
132 self.blend = None
133 self.failed = False
134
std::vector< SchemaItem< Flag > > * items

Member Function Documentation

◆ getParentProperty()

lsst.meas.deblender.baseline.DeblenderResult.getParentProperty ( self,
propertyName )
Get the footprint in each filter

Definition at line 135 of file baseline.py.

135 def getParentProperty(self, propertyName):
136 """Get the footprint in each filter
137 """
138 return [getattr(dp, propertyName) for dp in self.deblendedParents]
139

◆ setTemplateSums()

lsst.meas.deblender.baseline.DeblenderResult.setTemplateSums ( self,
templateSums,
fidx = None )

Definition at line 140 of file baseline.py.

140 def setTemplateSums(self, templateSums, fidx=None):
141 if fidx is not None:
142 self.templateSums[fidx] = templateSums
143 else:
144 for f, templateSum in templateSums.items():
145 self.deblendedParents[f].templateSum = templateSum
146
147

Member Data Documentation

◆ blend

lsst.meas.deblender.baseline.DeblenderResult.blend

Definition at line 132 of file baseline.py.

◆ deblendedParents

lsst.meas.deblender.baseline.DeblenderResult.deblendedParents

Definition at line 117 of file baseline.py.

◆ failed

lsst.meas.deblender.baseline.DeblenderResult.failed

Definition at line 133 of file baseline.py.

◆ filters

lsst.meas.deblender.baseline.DeblenderResult.filters

Definition at line 79 of file baseline.py.

◆ footprint

lsst.meas.deblender.baseline.DeblenderResult.footprint

Definition at line 109 of file baseline.py.

◆ log

lsst.meas.deblender.baseline.DeblenderResult.log

Definition at line 107 of file baseline.py.

◆ mMaskedImage

lsst.meas.deblender.baseline.DeblenderResult.mMaskedImage

Definition at line 108 of file baseline.py.

◆ peakCount

lsst.meas.deblender.baseline.DeblenderResult.peakCount

Definition at line 112 of file baseline.py.

◆ peaks

lsst.meas.deblender.baseline.DeblenderResult.peaks

Definition at line 125 of file baseline.py.

◆ psfs

lsst.meas.deblender.baseline.DeblenderResult.psfs

Definition at line 110 of file baseline.py.


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