lsst::afw::math::StatisticsControl Class Reference

Pass parameters to a Statistics object. More...

#include <Statistics.h>

Public Types
enum	WeightsBoolean { WEIGHTS_FALSE = 0 , WEIGHTS_TRUE = 1 , WEIGHTS_NONE }

Public Member Functions
	StatisticsControl (double numSigmaClip=3.0, int numIter=3, lsst::afw::image::MaskPixel andMask=0x0, bool isNanSafe=true, WeightsBoolean useWeights=WEIGHTS_NONE)
double	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.
void	setMaskPropagationThreshold (int bit, double threshold)
double	getNumSigmaClip () const noexcept
int	getNumIter () const noexcept
int	getAndMask () const noexcept
int	getNoGoodPixelsMask () const noexcept
bool	getNanSafe () const noexcept
bool	getWeighted () const noexcept
bool	getWeightedIsSet () const noexcept
bool	getCalcErrorFromInputVariance () const noexcept
bool	getCalcErrorMosaicMode () const noexcept
void	setNumSigmaClip (double numSigmaClip)
void	setNumIter (int numIter)
void	setAndMask (int andMask)
void	setNoGoodPixelsMask (int noGoodPixelsMask)
void	setNanSafe (bool isNanSafe) noexcept
void	setWeighted (bool useWeights) noexcept
void	setCalcErrorFromInputVariance (bool calcErrorFromInputVariance) noexcept
void	setCalcErrorMosaicMode (bool calcErrorMosaicMode) noexcept

Friends
class	Statistics

Detailed Description

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.

Member Enumeration Documentation

WeightsBoolean

enum lsst::afw::math::StatisticsControl::WeightsBoolean

Enumerator
WEIGHTS_FALSE
WEIGHTS_TRUE
WEIGHTS_NONE

Definition at line 85 of file Statistics.h.

{ WEIGHTS_FALSE = 0, WEIGHTS_TRUE = 1, WEIGHTS_NONE };  // initial state is NONE

Constructor & Destructor Documentation

StatisticsControl()

lsst::afw::math::StatisticsControl::StatisticsControl ( double numSigmaClip = 3.0, int numIter = 3, lsst::afw::image::MaskPixel andMask = 0x0, bool isNanSafe = true, WeightsBoolean useWeights = WEIGHTS_NONE )

inline

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.

            : _numSigmaClip(numSigmaClip),
              _numIter(numIter),
              _andMask(andMask),
              _noGoodPixelsMask(0x0),
              _isNanSafe(isNanSafe),
              _useWeights(useWeights),
              _calcErrorFromInputVariance(false),
              _calcErrorMosaicMode(false),
              _maskPropagationThresholds() {
        try {
            _noGoodPixelsMask = lsst::afw::image::Mask<>::getPlaneBitMask("NO_DATA");
        } catch (lsst::pex::exceptions::InvalidParameterError const &) {
            ;  // Mask has no NO_DATA plane defined
        }
 
        assert(_numSigmaClip > 0);
        assert(_numIter > 0);
    }

Member Function Documentation

getAndMask()

int lsst::afw::math::StatisticsControl::getAndMask ( ) const

inlinenoexcept

Definition at line 126 of file Statistics.h.

{ return _andMask; }

getCalcErrorFromInputVariance()

bool lsst::afw::math::StatisticsControl::getCalcErrorFromInputVariance ( ) const

inlinenoexcept

Definition at line 131 of file Statistics.h.

{ return _calcErrorFromInputVariance; }

getCalcErrorMosaicMode()

bool lsst::afw::math::StatisticsControl::getCalcErrorMosaicMode ( ) const

inlinenoexcept

Definition at line 132 of file Statistics.h.

{ return _calcErrorMosaicMode; }

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.

                                                                   {
    int oldSize = _maskPropagationThresholds.size();
    if (oldSize <= bit) {
        return 1.0;
    }
    return _maskPropagationThresholds[bit];
}

getNanSafe()

bool lsst::afw::math::StatisticsControl::getNanSafe ( ) const

inlinenoexcept

Definition at line 128 of file Statistics.h.

{ return _isNanSafe; }

getNoGoodPixelsMask()

int lsst::afw::math::StatisticsControl::getNoGoodPixelsMask ( ) const

inlinenoexcept

Definition at line 127 of file Statistics.h.

{ return _noGoodPixelsMask; }

getNumIter()

int lsst::afw::math::StatisticsControl::getNumIter ( ) const

inlinenoexcept

Definition at line 125 of file Statistics.h.

{ return _numIter; }

getNumSigmaClip()

double lsst::afw::math::StatisticsControl::getNumSigmaClip ( ) const

inlinenoexcept

Definition at line 124 of file Statistics.h.

{ return _numSigmaClip; }

getWeighted()

bool lsst::afw::math::StatisticsControl::getWeighted ( ) const

inlinenoexcept

Definition at line 129 of file Statistics.h.

{ return _useWeights == WEIGHTS_TRUE ? true : false; }

getWeightedIsSet()

bool lsst::afw::math::StatisticsControl::getWeightedIsSet ( ) const

inlinenoexcept

Definition at line 130 of file Statistics.h.

{ return _useWeights != WEIGHTS_NONE ? true : false; }

setAndMask()

void lsst::afw::math::StatisticsControl::setAndMask ( int andMask )

inline

Definition at line 148 of file Statistics.h.

{ _andMask = andMask; }

setCalcErrorFromInputVariance()

void lsst::afw::math::StatisticsControl::setCalcErrorFromInputVariance ( bool calcErrorFromInputVariance )

inlinenoexcept

Definition at line 152 of file Statistics.h.

                                                                                 {
        _calcErrorFromInputVariance = calcErrorFromInputVariance;
    }

setCalcErrorMosaicMode()

void lsst::afw::math::StatisticsControl::setCalcErrorMosaicMode ( bool calcErrorMosaicMode )

inlinenoexcept

Definition at line 155 of file Statistics.h.

                                                                   {
        _calcErrorMosaicMode = calcErrorMosaicMode;
    }

setMaskPropagationThreshold()

void lsst::afw::math::StatisticsControl::setMaskPropagationThreshold	(	int	bit,
		double	threshold )

Definition at line 750 of file Statistics.cc.

                                                                             {
    int oldSize = _maskPropagationThresholds.size();
    if (oldSize <= bit) {
        int newSize = bit + 1;
        _maskPropagationThresholds.resize(newSize);
        for (int i = oldSize; i < bit; ++i) {
            _maskPropagationThresholds[i] = 1.0;
        }
    }
    _maskPropagationThresholds[bit] = threshold;
}

setNanSafe()

void lsst::afw::math::StatisticsControl::setNanSafe ( bool isNanSafe )

inlinenoexcept

Definition at line 150 of file Statistics.h.

{ _isNanSafe = isNanSafe; }

setNoGoodPixelsMask()

void lsst::afw::math::StatisticsControl::setNoGoodPixelsMask ( int noGoodPixelsMask )

inline

Definition at line 149 of file Statistics.h.

{ _noGoodPixelsMask = noGoodPixelsMask; }

setNumIter()

void lsst::afw::math::StatisticsControl::setNumIter ( int numIter )

inline

Definition at line 141 of file Statistics.h.

                                 {
        if (!(numIter > 0)) {
            throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                              "numIter has to be positive.");
        }
        _numIter = numIter;
    }

setNumSigmaClip()

void lsst::afw::math::StatisticsControl::setNumSigmaClip ( double numSigmaClip )

inline

Definition at line 134 of file Statistics.h.

                                              {
        if (!(numSigmaClip > 0)) {
            throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                              "numSigmaClip has to be positive.");
        }
        _numSigmaClip = numSigmaClip;
    }

setWeighted()

void lsst::afw::math::StatisticsControl::setWeighted ( bool useWeights )

inlinenoexcept

Definition at line 151 of file Statistics.h.

{ _useWeights = useWeights ? WEIGHTS_TRUE : WEIGHTS_FALSE; }

Friends And Related Symbol Documentation

Statistics

friend class Statistics

friend

Definition at line 160 of file Statistics.h.

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+55fff6f525/include/lsst/afw/math/Statistics.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+55fff6f525/src/math/Statistics.cc