lsst.pipe.tasks g59f6dce098+83b7f37e51
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.pipe.tasks.multiBandUtils.CullPeaksConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.multiBandUtils.CullPeaksConfig:

Static Public Attributes

RangeField nBandsSufficient
 
RangeField rankSufficient
 
RangeField rankConsidered
 
RangeField 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:
 - 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.

Definition at line 27 of file multiBandUtils.py.

Member Data Documentation

◆ nBandsSufficient

RangeField 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 46 of file multiBandUtils.py.

◆ rankConsidered

RangeField 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 50 of file multiBandUtils.py.

◆ rankNormalizedConsidered

RangeField 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 53 of file multiBandUtils.py.

◆ rankSufficient

RangeField 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 48 of file multiBandUtils.py.


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