Pass parameters to a Statistics object.
More...
#include <Statistics.h>
Pass parameters to a Statistics object.
A class to pass parameters which control how the stats are calculated.
Definition at line 83 of file Statistics.h.
◆ WeightsBoolean
Enumerator |
---|
WEIGHTS_FALSE | |
WEIGHTS_TRUE | |
WEIGHTS_NONE | |
Definition at line 85 of file Statistics.h.
◆ StatisticsControl()
- Parameters
-
numSigmaClip | number of standard deviations to clip at |
numIter | Number of iterations |
andMask | and-Mask: defines which mask bits cause a value to be ignored |
isNanSafe | flag NaNs & Infs |
useWeights | use weighted statistics (via a vector or an inverse variance) |
Definition at line 87 of file Statistics.h.
◆ getAndMask()
int lsst::afw::math::StatisticsControl::getAndMask |
( |
| ) |
const |
|
inlinenoexcept |
◆ getCalcErrorFromInputVariance()
bool lsst::afw::math::StatisticsControl::getCalcErrorFromInputVariance |
( |
| ) |
const |
|
inlinenoexcept |
◆ getCalcErrorMosaicMode()
bool lsst::afw::math::StatisticsControl::getCalcErrorMosaicMode |
( |
| ) |
const |
|
inlinenoexcept |
◆ getMaskPropagationThreshold()
double lsst::afw::math::StatisticsControl::getMaskPropagationThreshold |
( |
int | bit | ) |
const |
When pixels with the given bit are rejected, we count what fraction the rejected pixels would have contributed (including the weights, if any) if those pixels had not been rejected, and set that bit in the return value of Statistics::getOrMask() if it exceeds the given threshold.
Definition at line 742 of file Statistics.cc.
◆ getNanSafe()
bool lsst::afw::math::StatisticsControl::getNanSafe |
( |
| ) |
const |
|
inlinenoexcept |
◆ getNoGoodPixelsMask()
int lsst::afw::math::StatisticsControl::getNoGoodPixelsMask |
( |
| ) |
const |
|
inlinenoexcept |
◆ getNumIter()
int lsst::afw::math::StatisticsControl::getNumIter |
( |
| ) |
const |
|
inlinenoexcept |
◆ getNumSigmaClip()
double lsst::afw::math::StatisticsControl::getNumSigmaClip |
( |
| ) |
const |
|
inlinenoexcept |
◆ getWeighted()
bool lsst::afw::math::StatisticsControl::getWeighted |
( |
| ) |
const |
|
inlinenoexcept |
◆ getWeightedIsSet()
bool lsst::afw::math::StatisticsControl::getWeightedIsSet |
( |
| ) |
const |
|
inlinenoexcept |
◆ setAndMask()
void lsst::afw::math::StatisticsControl::setAndMask |
( |
int | andMask | ) |
|
|
inline |
◆ setCalcErrorFromInputVariance()
void lsst::afw::math::StatisticsControl::setCalcErrorFromInputVariance |
( |
bool | calcErrorFromInputVariance | ) |
|
|
inlinenoexcept |
◆ setCalcErrorMosaicMode()
void lsst::afw::math::StatisticsControl::setCalcErrorMosaicMode |
( |
bool | calcErrorMosaicMode | ) |
|
|
inlinenoexcept |
◆ setMaskPropagationThreshold()
void lsst::afw::math::StatisticsControl::setMaskPropagationThreshold |
( |
int | bit, |
|
|
double | threshold ) |
◆ setNanSafe()
void lsst::afw::math::StatisticsControl::setNanSafe |
( |
bool | isNanSafe | ) |
|
|
inlinenoexcept |
◆ setNoGoodPixelsMask()
void lsst::afw::math::StatisticsControl::setNoGoodPixelsMask |
( |
int | noGoodPixelsMask | ) |
|
|
inline |
◆ setNumIter()
void lsst::afw::math::StatisticsControl::setNumIter |
( |
int | numIter | ) |
|
|
inline |
◆ setNumSigmaClip()
void lsst::afw::math::StatisticsControl::setNumSigmaClip |
( |
double | numSigmaClip | ) |
|
|
inline |
◆ setWeighted()
void lsst::afw::math::StatisticsControl::setWeighted |
( |
bool | useWeights | ) |
|
|
inlinenoexcept |
◆ Statistics
The documentation for this class was generated from the following files: