LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+bd2ed33bd6,g1470d8bcf6+de7501a2e0,g14a832a312+ff425fae3c,g2079a07aa2+86d27d4dc4,g2305ad1205+91a32aca49,g295015adf3+762506a1ad,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+c34e8be1fa,g487adcacf7+5fae3daba8,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ea1711114f,g5a732f18d5+53520f316c,g64a986408d+bd2ed33bd6,g858d7b2824+bd2ed33bd6,g8a8a8dda67+585e252eca,g99cad8db69+016a06b37a,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+ef4e3a5875,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+09e12c87ab,gc120e1dc64+bc2e06c061,gc28159a63d+0e5473021a,gcf0d15dbbd+c34e8be1fa,gdaeeff99f8+f9a426f77a,ge6526c86ff+508d0e0a30,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+8d59551888,gf1cff7945b+bd2ed33bd6,w.2024.16
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.