lsst.afw gba47b54d5d+c2b65f28c3
|
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 |
return Threshold's polarity
Definition at line 92 of file Threshold.h.
|
inlinenoexcept |
return type of threshold
Definition at line 71 of file Threshold.h.
|
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.