Coverage for python/lsst/pipe/tasks/multiBandUtils.py: 100%

7 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-04-15 10:48 +0000

1# This file is part of pipe_tasks. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <https://www.gnu.org/licenses/>. 

21 

22__all__ = ["CullPeaksConfig"] 

23 

24from lsst.pex.config import Config, RangeField 

25 

26 

27class CullPeaksConfig(Config): 

28 """Configuration for culling garbage peaks after merging footprints. 

29 

30 Peaks may also be culled after detection or during deblending; this configuration object 

31 only deals with culling after merging Footprints. 

32 

33 These cuts are based on three quantities: 

34 - nBands: the number of bands in which the peak was detected 

35 - peakRank: the position of the peak within its family, sorted from brightest to faintest. 

36 - peakRankNormalized: the peak rank divided by the total number of peaks in the family. 

37 

38 The formula that identifie peaks to cull is: 

39 

40 nBands < nBandsSufficient 

41 AND (rank >= rankSufficient) 

42 AND (rank >= rankConsider OR rank >= rankNormalizedConsider) 

43 

44 To disable peak culling, simply set nBandsSufficient=1. 

45 """ 

46 nBandsSufficient = RangeField(dtype=int, default=2, min=1, 

47 doc="Always keep peaks detected in this many bands") 

48 rankSufficient = RangeField(dtype=int, default=20, min=1, 

49 doc="Always keep this many peaks in each family") 

50 rankConsidered = RangeField(dtype=int, default=30, min=1, 

51 doc=("Keep peaks with less than this rank that also match the " 

52 "rankNormalizedConsidered condition.")) 

53 rankNormalizedConsidered = RangeField(dtype=float, default=0.7, min=0.0, 

54 doc=("Keep peaks with less than this normalized rank that" 

55 " also match the rankConsidered condition."))