lsst.pipe.tasks  13.0-59-g0001361c+3
 All Classes Namespaces Files Functions Variables Groups Pages
Static Public Attributes | List of all members
lsst.pipe.tasks.multiBand.CullPeaksConfig Class Reference

Configuration for culling garbage peaks after merging footprints. More...

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

Static Public Attributes

tuple nBandsSufficient
 
tuple rankSufficient
 
tuple rankConsidered
 
tuple 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 519 of file multiBand.py.

Member Data Documentation

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

Definition at line 542 of file multiBand.py.

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

Definition at line 546 of file multiBand.py.

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

Definition at line 549 of file multiBand.py.

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

Definition at line 544 of file multiBand.py.


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