LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Threshold.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008, 2009, 2010 LSST Corporation.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #if !defined(LSST_DETECTION_THRESHOLD_H)
24 #define LSST_DETECTION_THRESHOLD_H
25 /*
26  * Represent a detection threshold.
27  */
28 
29 namespace lsst {
30 namespace afw {
31 namespace detection {
32 
44 public:
52  };
53 
57  Threshold(double const value,
58  ThresholdType const type = VALUE,
59  bool const polarity = true,
60  double const includeMultiplier = 1.0
61  )
62  : _value(value), _type(type), _polarity(polarity), _includeMultiplier(includeMultiplier) {}
63 
64  ~Threshold() noexcept = default;
65  Threshold(Threshold const &) noexcept = default;
66  Threshold(Threshold &&) noexcept = default;
67  Threshold &operator=(Threshold const &) noexcept = default;
68  Threshold &operator=(Threshold &&) noexcept = default;
69 
71  ThresholdType getType() const noexcept { return _type; }
72 
73  static ThresholdType parseTypeString(std::string const &typeStr);
75 
81  double getValue(const double param = -1) const;
82 
88  template <typename ImageT>
89  double getValue(ImageT const &image) const;
90 
92  bool getPolarity() const noexcept { return _polarity; }
94  void setPolarity(bool const polarity
95  ) noexcept {
96  _polarity = polarity;
97  }
98 
100  double getIncludeMultiplier() const noexcept { return _includeMultiplier; }
102  void setIncludeMultiplier(double const includeMultiplier
103  ) {
104  _includeMultiplier = includeMultiplier;
105  }
106 
107 private:
108  double _value;
109  ThresholdType _type;
110  bool _polarity;
111  double _includeMultiplier;
112 };
113 
124 Threshold createThreshold(const double value, const std::string type = "value", const bool polarity = true);
125 } // namespace detection
126 } // namespace afw
127 } // namespace lsst
128 
129 #endif
table::Key< int > type
Definition: Detector.cc:163
A Threshold is used to pass a threshold value to detection algorithms.
Definition: Threshold.h:43
bool getPolarity() const noexcept
return Threshold's polarity
Definition: Threshold.h:92
static std::string getTypeString(ThresholdType const &type)
Definition: Threshold.cc:54
static ThresholdType parseTypeString(std::string const &typeStr)
Definition: Threshold.cc:37
void setPolarity(bool const polarity) noexcept
set Threshold's polarity
Definition: Threshold.h:94
Threshold(double const value, ThresholdType const type=VALUE, bool const polarity=true, double const includeMultiplier=1.0)
Threshold constructor.
Definition: Threshold.h:57
double getIncludeMultiplier() const noexcept
return includeMultiplier
Definition: Threshold.h:100
double getValue(const double param=-1) const
return value of threshold, to be interpreted via type
Definition: Threshold.cc:67
~Threshold() noexcept=default
void setIncludeMultiplier(double const includeMultiplier)
set includeMultiplier
Definition: Threshold.h:102
ThresholdType
Types of threshold:
Definition: Threshold.h:46
@ VARIANCE
Use number of sigma given variance.
Definition: Threshold.h:50
@ VALUE
Use pixel value.
Definition: Threshold.h:47
@ PIXEL_STDEV
Use number of sigma given per-pixel s.d.
Definition: Threshold.h:51
@ STDEV
Use number of sigma given s.d.
Definition: Threshold.h:49
@ BITMASK
Use (pixels & (given mask))
Definition: Threshold.h:48
ThresholdType getType() const noexcept
return type of threshold
Definition: Threshold.h:71
Threshold createThreshold(const double value, const std::string type="value", const bool polarity=true)
Factory method for creating Threshold objects.
Definition: Threshold.cc:109
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
A base class for image defects.