LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Threshold.cc
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#include <cstdint>
23#include <cmath>
24#include <string>
25#include <boost/format.hpp>
26#include "lsst/pex/exceptions.h"
27#include "lsst/log/Log.h"
32
33namespace lsst {
34namespace afw {
35namespace detection {
36
38 if (typeStr.compare("bitmask") == 0) {
39 return Threshold::BITMASK;
40 } else if (typeStr.compare("value") == 0) {
41 return Threshold::VALUE;
42 } else if (typeStr.compare("stdev") == 0) {
43 return Threshold::STDEV;
44 } else if (typeStr.compare("variance") == 0) {
46 } else if (typeStr.compare("pixel_stdev") == 0) {
48 } else {
50 (boost::format("Unsupported Threshold type: %s") % typeStr).str());
51 }
52}
53
55 if (type == VALUE) {
56 return "value";
57 } else if (type == STDEV) {
58 return "stdev";
59 } else if (type == VARIANCE) {
60 return "variance";
61 } else {
63 (boost::format("Unsopported Threshold type: %d") % type).str());
64 }
65}
66
67double Threshold::getValue(const double param) const {
68 switch (_type) {
69 case STDEV:
70 if (param <= 0) {
72 (boost::format("St. dev. must be > 0: %g") % param).str());
73 }
74 return _value * param;
75 case VALUE:
76 case BITMASK:
77 case PIXEL_STDEV:
78 return _value;
79 case VARIANCE:
80 if (param <= 0) {
82 (boost::format("Variance must be > 0: %g") % param).str());
83 }
84 return _value * std::sqrt(param);
85 default:
87 (boost::format("Unsupported type: %d") % _type).str());
88 }
89}
90
91template <typename ImageT>
92double Threshold::getValue(ImageT const& image) const {
93 double param = -1; // Parameter for getValue()
94 if (_type == STDEV || _type == VARIANCE) {
96 double const sd = stats.getValue(math::STDEVCLIP);
97
98 LOGL_DEBUG("lsst.afw.detection.threshold", "St. Dev = %g", sd);
99
100 if (_type == VARIANCE) {
101 param = sd * sd;
102 } else {
103 param = sd;
104 }
105 }
106 return getValue(param);
107}
108
109Threshold createThreshold(double const value, std::string const typeStr, bool const polarity) {
110 return Threshold(value, Threshold::parseTypeString(typeStr), polarity);
111}
112
113//
114// Explicit instantiations
115//
116#define INSTANTIATE(TYPE) \
117 template double Threshold::getValue(image::TYPE<unsigned short> const&) const; \
118 template double Threshold::getValue(image::TYPE<int> const&) const; \
119 template double Threshold::getValue(image::TYPE<float> const&) const; \
120 template double Threshold::getValue(image::TYPE<double> const&) const; \
121 template double Threshold::getValue(image::TYPE<std::uint64_t> const&) const;
122
123#ifndef DOXYGEN
124INSTANTIATE(Image);
125INSTANTIATE(MaskedImage);
126#endif
127} // namespace detection
128} // namespace afw
129} // namespace lsst
#define INSTANTIATE(FROMSYS, TOSYS)
Definition Detector.cc:509
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
LSST DM logging module built on log4cxx.
#define LOGL_DEBUG(logger, message...)
Log a debug-level message using a varargs/printf style interface.
Definition Log.h:515
A Threshold is used to pass a threshold value to detection algorithms.
Definition Threshold.h:43
static std::string getTypeString(ThresholdType const &type)
Definition Threshold.cc:54
static ThresholdType parseTypeString(std::string const &typeStr)
Definition Threshold.cc:37
double getValue(const double param=-1) const
return value of threshold, to be interpreted via type
Definition Threshold.cc:67
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
A class to evaluate image statistics.
Definition Statistics.h:222
Reports invalid arguments.
Definition Runtime.h:66
T compare(T... args)
Threshold createThreshold(const double value, const std::string type="value", const bool polarity=true)
Factory method for creating Threshold objects.
Definition Threshold.cc:109
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition Statistics.h:361
@ STDEVCLIP
estimate sample N-sigma clipped stdev (N set in StatisticsControl, default=3)
Definition Statistics.h:63
T sqrt(T... args)