LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
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. More... | |
~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 More... | |
double | getValue (const double param=-1) const |
return value of threshold, to be interpreted via type More... | |
template<typename ImageT > | |
double | getValue (ImageT const &image) const |
return value of threshold by interrogating the image, if required More... | |
bool | getPolarity () const noexcept |
return Threshold's polarity More... | |
void | setPolarity (bool const polarity) noexcept |
set Threshold's polarity More... | |
double | getIncludeMultiplier () const noexcept |
return includeMultiplier More... | |
void | setIncludeMultiplier (double const includeMultiplier) |
set includeMultiplier More... | |
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.