LSST Applications g044012fb7c+bcde43e0cd,g04a91732dc+5ded33dca8,g07dc498a13+f701f15b83,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+bb8b3b62bc,g2179890f76+b0e6738434,g35bb328faa+0eb18584fe,g3bd4b5ce2c+3bd6caf1d1,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+855785d0b2,g623d845a50+855785d0b2,g6f0c2978f1+63e17faf73,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+a847daa3c3,g89139ef638+f701f15b83,g8b49a6ea8e+855785d0b2,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g97db14605f+39e2ace225,g989de1cb63+f701f15b83,g9f33ca652e+0886102515,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gb1101e3267+5be896e349,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+a847daa3c3,gd0fa69b896+dcb3cf4724,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+0b84c86a2a,ge278dab8ac+ae64226a64,geab183fbe5+855785d0b2,gfba249425e+0eb18584fe,w.2025.07
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.