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:
 - 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 nBandsSafe=1.

Definition at line 344 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 364 of file multiBand.py.

tuple lsst.pipe.tasks.multiBand.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 368 of file multiBand.py.

tuple lsst.pipe.tasks.multiBand.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 371 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 366 of file multiBand.py.

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

/home/lsstsw/stack/Linux64/pipe_tasks/11.0-2-g818369d/python/lsst/pipe/tasks/multiBand.py

Static Public Attributes

Detailed Description

Member Data Documentation