lsst.pipe.tasks 21.0.0-175-g7497abfa+2a6ce44392
Static Public Attributes | List of all members
lsst.pipe.tasks.multiBandUtils.CullPeaksConfig Class Reference

More...

Inheritance diagram for lsst.pipe.tasks.multiBandUtils.CullPeaksConfig:

Static Public Attributes

 nBandsSufficient
 
 rankSufficient
 
 rankConsidered
 
 rankNormalizedConsidered
 

Detailed Description

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:

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.

Definition at line 176 of file multiBandUtils.py.

Member Data Documentation

◆ nBandsSufficient

lsst.pipe.tasks.multiBandUtils.CullPeaksConfig.nBandsSufficient
static
Initial value:
= RangeField(dtype=int, default=2, min=1,
doc="Always keep peaks detected in this many bands")

Definition at line 199 of file multiBandUtils.py.

◆ rankConsidered

lsst.pipe.tasks.multiBandUtils.CullPeaksConfig.rankConsidered
static
Initial value:
= RangeField(dtype=int, default=30, min=1,
doc=("Keep peaks with less than this rank that also match the "
"rankNormalizedConsidered condition."))

Definition at line 203 of file multiBandUtils.py.

◆ rankNormalizedConsidered

lsst.pipe.tasks.multiBandUtils.CullPeaksConfig.rankNormalizedConsidered
static
Initial value:
= RangeField(dtype=float, default=0.7, min=0.0,
doc=("Keep peaks with less than this normalized rank that"
" also match the rankConsidered condition."))

Definition at line 206 of file multiBandUtils.py.

◆ rankSufficient

lsst.pipe.tasks.multiBandUtils.CullPeaksConfig.rankSufficient
static
Initial value:
= RangeField(dtype=int, default=20, min=1,
doc="Always keep this many peaks in each family")

Definition at line 201 of file multiBandUtils.py.


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