|
LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
|
A Threshold is used to pass a threshold value to detection algorithms. More...
#include <Threshold.h>
Public Types | |
| enum | ThresholdType { VALUE , BITMASK , STDEV , VARIANCE , PIXEL_STDEV } |
| Types of threshold: More... | |
Public Member Functions | |
| Threshold (double const value, ThresholdType const type=VALUE, bool const polarity=true, double const includeMultiplier=1.0) | |
| Threshold constructor. | |
| ~Threshold () noexcept=default | |
| Threshold (Threshold const &) noexcept=default | |
| Threshold (Threshold &&) noexcept=default | |
| Threshold & | operator= (Threshold const &) noexcept=default |
| Threshold & | operator= (Threshold &&) noexcept=default |
| ThresholdType | getType () const noexcept |
| return type of threshold | |
| double | getValue (const double param=-1) const |
| return value of threshold, to be interpreted via type | |
| template<typename ImageT> | |
| double | getValue (ImageT const &image) const |
| return value of threshold by interrogating the image, if required | |
| bool | getPolarity () const noexcept |
| return Threshold's polarity | |
| void | setPolarity (bool const polarity) noexcept |
| set Threshold's polarity | |
| double | getIncludeMultiplier () const noexcept |
| return includeMultiplier | |
| void | setIncludeMultiplier (double const includeMultiplier) |
| set includeMultiplier | |
Static Public Member Functions | |
| static ThresholdType | parseTypeString (std::string const &typeStr) |
| static std::string | getTypeString (ThresholdType const &type) |
A Threshold is used to pass a threshold value to detection algorithms.
The threshold may be a simple value (type == VALUE), or in units of the image standard deviation. Alternatively you may specify that you'll provide the standard deviation (type == STDEV) or variance (type == VARIANCE)
Note that the constructor is not declared explicit, so you may pass a bare threshold, and it'll be interpreted as a VALUE.
Definition at line 43 of file Threshold.h.
Types of threshold:
Definition at line 46 of file Threshold.h.
|
inline |
Threshold constructor.
| value | desired threshold value |
| type | interpretation of type |
| polarity | search pixel above threshold? (useful for -ve thresholds) |
| includeMultiplier | threshold multiplier for inclusion in FootprintSet |
Definition at line 57 of file Threshold.h.
|
defaultnoexcept |
|
defaultnoexcept |
|
defaultnoexcept |
|
inlinenoexcept |
return includeMultiplier
Definition at line 100 of file Threshold.h.
|
inlinenoexcept |
|
inlinenoexcept |
|
static |
Definition at line 54 of file Threshold.cc.
| double lsst::afw::detection::Threshold::getValue | ( | const double | param = -1 | ) | const |
return value of threshold, to be interpreted via type
| param | value of variance/stdev if needed |
Definition at line 67 of file Threshold.cc.
| double lsst::afw::detection::Threshold::getValue | ( | ImageT const & | image | ) | const |
return value of threshold by interrogating the image, if required
| image | Image to interrogate, if threshold type demands |
Definition at line 92 of file Threshold.cc.
|
static |
Definition at line 37 of file Threshold.cc.
|
inline |
set includeMultiplier
| includeMultiplier | desired multiplier |
Definition at line 102 of file Threshold.h.
|
inlinenoexcept |
set Threshold's polarity
| polarity | desired polarity |
Definition at line 94 of file Threshold.h.