LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::detection::Threshold Class Referencefinal

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)
 

Detailed Description

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.

Member Enumeration Documentation

◆ ThresholdType

enum lsst::afw::detection::Threshold::ThresholdType

Types of threshold:

Enumerator
VALUE 

Use pixel value.

BITMASK 

Use (pixels & (given mask))

STDEV 

Use number of sigma given s.d.

VARIANCE 

Use number of sigma given variance.

PIXEL_STDEV 

Use number of sigma given per-pixel s.d.

Definition at line 46 of file Threshold.h.

46  {
47  VALUE,
48  BITMASK,
49  STDEV,
50  VARIANCE,
51  PIXEL_STDEV
52  };
lsst::afw::detection::Threshold::VARIANCE
@ VARIANCE
Use number of sigma given variance.
Definition: Threshold.h:50
lsst::afw::detection::Threshold::VALUE
@ VALUE
Use pixel value.
Definition: Threshold.h:47
lsst::afw::detection::Threshold::PIXEL_STDEV
@ PIXEL_STDEV
Use number of sigma given per-pixel s.d.
Definition: Threshold.h:51
lsst::afw::detection::Threshold::STDEV
@ STDEV
Use number of sigma given s.d.
Definition: Threshold.h:49
lsst::afw::detection::Threshold::BITMASK
@ BITMASK
Use (pixels & (given mask))
Definition: Threshold.h:48

Constructor & Destructor Documentation

◆ Threshold() [1/3]

lsst::afw::detection::Threshold::Threshold ( double const  value,
ThresholdType const  type = VALUE,
bool const  polarity = true,
double const  includeMultiplier = 1.0 
)
inline

Threshold constructor.

Parameters
valuedesired threshold value
typeinterpretation of type
polaritysearch pixel above threshold? (useful for -ve thresholds)
includeMultiplierthreshold multiplier for inclusion in FootprintSet

Definition at line 57 of file Threshold.h.

62  : _value(value), _type(type), _polarity(polarity), _includeMultiplier(includeMultiplier) {}
type
table::Key< int > type
Definition: Detector.cc:163

◆ ~Threshold()

lsst::afw::detection::Threshold::~Threshold ( )
defaultnoexcept

◆ Threshold() [2/3]

lsst::afw::detection::Threshold::Threshold ( Threshold const &  )
defaultnoexcept

◆ Threshold() [3/3]

lsst::afw::detection::Threshold::Threshold ( Threshold &&  )
defaultnoexcept

Member Function Documentation

◆ getIncludeMultiplier()

double lsst::afw::detection::Threshold::getIncludeMultiplier ( ) const
inlinenoexcept

return includeMultiplier

Definition at line 100 of file Threshold.h.

100 { return _includeMultiplier; }

◆ getPolarity()

bool lsst::afw::detection::Threshold::getPolarity ( ) const
inlinenoexcept

return Threshold's polarity

Definition at line 92 of file Threshold.h.

92 { return _polarity; }

◆ getType()

ThresholdType lsst::afw::detection::Threshold::getType ( ) const
inlinenoexcept

return type of threshold

Definition at line 71 of file Threshold.h.

71 { return _type; }

◆ getTypeString()

std::string lsst::afw::detection::Threshold::getTypeString ( ThresholdType const &  type)
static

Definition at line 54 of file Threshold.cc.

54  {
55  if (type == VALUE) {
56  return "value";
57  } else if (type == STDEV) {
58  return "stdev";
59  } else if (type == VARIANCE) {
60  return "variance";
61  } else {
62  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
63  (boost::format("Unsopported Threshold type: %d") % type).str());
64  }
65 }
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst.pex::exceptions::InvalidParameterError
Reports invalid arguments.
Definition: Runtime.h:66
lsst.pex.config.history.format
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ getValue() [1/2]

double lsst::afw::detection::Threshold::getValue ( const double  param = -1) const

return value of threshold, to be interpreted via type

Parameters
paramvalue of variance/stdev if needed
Returns
value of threshold

Definition at line 67 of file Threshold.cc.

67  {
68  switch (_type) {
69  case STDEV:
70  if (param <= 0) {
71  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
72  (boost::format("St. dev. must be > 0: %g") % param).str());
73  }
74  return _value * param;
75  case VALUE:
76  case BITMASK:
77  case PIXEL_STDEV:
78  return _value;
79  case VARIANCE:
80  if (param <= 0) {
81  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
82  (boost::format("Variance must be > 0: %g") % param).str());
83  }
84  return _value * std::sqrt(param);
85  default:
86  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
87  (boost::format("Unsupported type: %d") % _type).str());
88  }
89 }
std::sqrt
T sqrt(T... args)

◆ getValue() [2/2]

template<typename ImageT >
double lsst::afw::detection::Threshold::getValue ( ImageT const &  image) const

return value of threshold by interrogating the image, if required

Parameters
imageImage to interrogate, if threshold type demands
Returns
value of threshold

Definition at line 92 of file Threshold.cc.

92  {
93  double param = -1; // Parameter for getValue()
94  if (_type == STDEV || _type == VARIANCE) {
95  math::Statistics stats = math::makeStatistics(image, math::STDEVCLIP);
96  double const sd = stats.getValue(math::STDEVCLIP);
97 
98  LOGL_DEBUG("lsst.afw.detection.threshold", "St. Dev = %g", sd);
99 
100  if (_type == VARIANCE) {
101  param = sd * sd;
102  } else {
103  param = sd;
104  }
105  }
106  return getValue(param);
107 }
LOGL_DEBUG
#define LOGL_DEBUG(logger, message...)
Log a debug-level message using a varargs/printf style interface.
Definition: Log.h:515
lsst::afw::detection::Threshold::getValue
double getValue(const double param=-1) const
return value of threshold, to be interpreted via type
Definition: Threshold.cc:67
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::afw::math::makeStatistics
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition: Statistics.h:359
lsst::afw::math::STDEVCLIP
@ STDEVCLIP
estimate sample N-sigma clipped stdev (N set in StatisticsControl, default=3)
Definition: Statistics.h:72

◆ operator=() [1/2]

Threshold& lsst::afw::detection::Threshold::operator= ( Threshold &&  )
defaultnoexcept

◆ operator=() [2/2]

Threshold& lsst::afw::detection::Threshold::operator= ( Threshold const &  )
defaultnoexcept

◆ parseTypeString()

Threshold::ThresholdType lsst::afw::detection::Threshold::parseTypeString ( std::string const &  typeStr)
static

Definition at line 37 of file Threshold.cc.

37  {
38  if (typeStr.compare("bitmask") == 0) {
39  return Threshold::BITMASK;
40  } else if (typeStr.compare("value") == 0) {
41  return Threshold::VALUE;
42  } else if (typeStr.compare("stdev") == 0) {
43  return Threshold::STDEV;
44  } else if (typeStr.compare("variance") == 0) {
45  return Threshold::VARIANCE;
46  } else if (typeStr.compare("pixel_stdev") == 0) {
47  return Threshold::PIXEL_STDEV;
48  } else {
49  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
50  (boost::format("Unsupported Threshold type: %s") % typeStr).str());
51  }
52 }

◆ setIncludeMultiplier()

void lsst::afw::detection::Threshold::setIncludeMultiplier ( double const  includeMultiplier)
inline

set includeMultiplier

Parameters
includeMultiplierdesired multiplier

Definition at line 102 of file Threshold.h.

103  {
104  _includeMultiplier = includeMultiplier;
105  }

◆ setPolarity()

void lsst::afw::detection::Threshold::setPolarity ( bool const  polarity)
inlinenoexcept

set Threshold's polarity

Parameters
polaritydesired polarity

Definition at line 94 of file Threshold.h.

95  {
96  _polarity = polarity;
97  }
The documentation for this class was generated from the following files:
Generated on Fri Nov 26 2021 10:16:10 for LSST Applications by doxygen 1.9.1