CullPeaksConfig#

class lsst.pipe.tasks.multiBandUtils.CullPeaksConfig(*args, **kw)#

Configuration for culling garbage peaks after merging footprints.

Peaks may also be culled after detection or during deblending; this configuration object only deals with culling after merging Footprints.

These cuts are based on three quantities:

nBands: the number of bands in which the peak was detected
peakRank: the position of the peak within its family, sorted from brightest to faintest.
peakRankNormalized: the peak rank divided by the total number of peaks in the family.

The formula that identifie peaks to cull is:

nBands < nBandsSufficient
AND (rank >= rankSufficient) AND (rank >= rankConsider OR rank >= rankNormalizedConsider)

To disable peak culling, simply set nBandsSufficient=1.

Attributes Summary

`nBandsSufficient`	Always keep peaks detected in this many bands (`int`, default `2`)
`rankConsidered`	Keep peaks with less than this rank that also match the rankNormalizedConsidered condition.
`rankNormalizedConsidered`	Keep peaks with less than this normalized rank that also match the rankConsidered condition.
`rankSufficient`	Always keep this many peaks in each family (`int`, default `20`)

Attributes Documentation

nBandsSufficient#

Always keep peaks detected in this many bands (int, default 2)

Valid Range = [1,inf)

rankConsidered#

Keep peaks with less than this rank that also match the rankNormalizedConsidered condition. (int, default 30)

Valid Range = [1,inf)

rankNormalizedConsidered#

Keep peaks with less than this normalized rank that also match the rankConsidered condition. (float, default 0.7)

Valid Range = [0.0,inf)

rankSufficient#

Always keep this many peaks in each family (int, default 20)

Valid Range = [1,inf)