Loading [MathJax]/extensions/tex2jax.js
LSST Applications g044012fb7c+bcde43e0cd,g04a91732dc+5ded33dca8,g07dc498a13+f701f15b83,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+bb8b3b62bc,g2179890f76+b0e6738434,g35bb328faa+0eb18584fe,g3bd4b5ce2c+3bd6caf1d1,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+855785d0b2,g623d845a50+855785d0b2,g6f0c2978f1+63e17faf73,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+a847daa3c3,g89139ef638+f701f15b83,g8b49a6ea8e+855785d0b2,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g97db14605f+39e2ace225,g989de1cb63+f701f15b83,g9f33ca652e+0886102515,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gb1101e3267+5be896e349,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+a847daa3c3,gd0fa69b896+dcb3cf4724,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+0b84c86a2a,ge278dab8ac+ae64226a64,geab183fbe5+855785d0b2,gfba249425e+0eb18584fe,w.2025.07
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
29namespace lsst {
30namespace afw {
31namespace detection {
32
43class Threshold final {
44public:
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);
74 static std::string getTypeString(ThresholdType const &type);
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
107private:
108 double _value;
109 ThresholdType _type;
110 bool _polarity;
111 double _includeMultiplier;
112};
113
124Threshold 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
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
@ 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