LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
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