LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
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 
30 namespace lsst {
31 namespace afw {
32 namespace detection {
33 
44 class Threshold {
45 public:
53  };
54 
59  double const value,
60  ThresholdType const type = VALUE,
61  bool const polarity = true,
62  double const includeMultiplier = 1.0
63  ) : _value(value), _type(type), _polarity(polarity),
64  _includeMultiplier(includeMultiplier) {}
65 
67  ThresholdType getType() const { return _type; }
68 
69  static ThresholdType parseTypeString(std::string const & typeStr);
70  static std::string getTypeString(ThresholdType const & type);
71 
77  double getValue(const double param = -1) const;
78 
84  template<typename ImageT>
85  double getValue(ImageT const& image) const;
86 
88  bool getPolarity() const { return _polarity; }
90  void setPolarity(bool const polarity
91  ) { _polarity = polarity; }
92 
94  double getIncludeMultiplier() const { return _includeMultiplier; }
96  void setIncludeMultiplier(double const includeMultiplier
97  ) { _includeMultiplier = includeMultiplier; }
98 
99 private:
100  double _value;
102  bool _polarity;
104 };
105 
106 // brief Factory method for creating Threshold objects
107 Threshold createThreshold(const double value,
108  const std::string type = "value",
109  const bool polarity = true);
110 }}}
111 
112 #endif
void setIncludeMultiplier(double const includeMultiplier)
set includeMultiplier
Definition: Threshold.h:96
Use number of sigma given per-pixel s.d.
Definition: Threshold.h:52
A Threshold is used to pass a threshold value to detection algorithms.
Definition: Threshold.h:44
double _value
value of threshold, to be interpreted via _type
Definition: Threshold.h:100
ThresholdType _type
type of threshold
Definition: Threshold.h:101
bool _polarity
true for positive polarity, false for negative
Definition: Threshold.h:102
Vector param
table::Key< table::Array< Kernel::Pixel > > image
Definition: FixedKernel.cc:117
Use (pixels &amp; (given mask))
Definition: Threshold.h:49
static std::string getTypeString(ThresholdType const &type)
Definition: Threshold.cc:59
bool getPolarity() const
return Threshold&#39;s polarity
Definition: Threshold.h:88
Use number of sigma given variance.
Definition: Threshold.h:51
void setPolarity(bool const polarity)
set Threshold&#39;s polarity
Definition: Threshold.h:90
Threshold createThreshold(const double value, const std::string type="value", const bool polarity=true)
Factory method for creating Threshold objects.
Definition: Threshold.cc:138
double getIncludeMultiplier() const
return includeMultiplier
Definition: Threshold.h:94
double getValue(const double param=-1) const
Definition: Threshold.cc:79
ThresholdType
Types of threshold:
Definition: Threshold.h:47
Threshold(double const value, ThresholdType const type=VALUE, bool const polarity=true, double const includeMultiplier=1.0)
Definition: Threshold.h:58
Use number of sigma given s.d.
Definition: Threshold.h:50
static ThresholdType parseTypeString(std::string const &typeStr)
Definition: Threshold.cc:40
ThresholdType getType() const
return type of threshold
Definition: Threshold.h:67
double _includeMultiplier
multiplier for threshold needed for inclusion in FootprintSet
Definition: Threshold.h:103