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

Pass parameters to a Statistics objectA class to pass parameters which control how the stats are calculated. More...

#include <Statistics.h>

Public Types
typedef boost::shared_ptr < StatisticsControl >	Ptr
typedef boost::shared_ptr < StatisticsControl > const	ConstPtr

Public Member Functions
	StatisticsControl (double numSigmaClip=3.0, int numIter=3, lsst::afw::image::MaskPixel andMask=0x0, bool isNanSafe=true, int useWeights=WEIGHTS_NONE)
double	getNumSigmaClip () const
int	getNumIter () const
int	getAndMask () const
int	getNoGoodPixelsMask () const
bool	getNanSafe () const
bool	getWeighted () const
bool	getWeightedIsSet () const
bool	getCalcErrorFromInputVariance () const
void	setNumSigmaClip (double numSigmaClip)
void	setNumIter (int numIter)
void	setAndMask (int andMask)
void	setNoGoodPixelsMask (int noGoodPixelsMask)
void	setNanSafe (bool isNanSafe)
void	setWeighted (bool useWeights)
void	setCalcErrorFromInputVariance (bool calcErrorFromInputVariance)
double	getMaskPropagationThreshold (int bit) const
void	setMaskPropagationThreshold (int bit, double threshold)

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

Private Attributes
double	_numSigmaClip
int	_numIter
int	_andMask
int	_noGoodPixelsMask
bool	_isNanSafe
WeightsBoolean	_useWeights
bool	_calcErrorFromInputVariance
std::vector< double >	_maskPropagationThresholds

Friends
class	Statistics

Detailed Description

Pass parameters to a Statistics object

A class to pass parameters which control how the stats are calculated.

Examples:

imageStatistics.cc.

Definition at line 92 of file Statistics.h.

Member Typedef Documentation

typedef boost::shared_ptr<StatisticsControl> const lsst::afw::math::StatisticsControl::ConstPtr

Definition at line 97 of file Statistics.h.

typedef boost::shared_ptr<StatisticsControl> lsst::afw::math::StatisticsControl::Ptr

Definition at line 96 of file Statistics.h.

Member Enumeration Documentation

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

private

Enumerator
WEIGHTS_FALSE
WEIGHTS_TRUE
WEIGHTS_NONE

Definition at line 93 of file Statistics.h.

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

Constructor & Destructor Documentation

lsst::afw::math::StatisticsControl::StatisticsControl ( double  numSigmaClip = 3.0, int  numIter = 3, lsst::afw::image::MaskPixel  andMask = 0x0, bool  isNanSafe = true, int  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 99 of file Statistics.h.

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

        assert(_numSigmaClip > 0);
        assert(_numIter > 0);
    }

Member Function Documentation

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

inline

Definition at line 137 of file Statistics.h.

{ return _andMask; }

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

inline

Definition at line 142 of file Statistics.h.

{ return _calcErrorFromInputVariance; }

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 691 of file Statistics.cc.

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

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

inline

Definition at line 139 of file Statistics.h.

{ return _isNanSafe; }

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

inline

Definition at line 138 of file Statistics.h.

{ return _noGoodPixelsMask; }

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

inline

Definition at line 136 of file Statistics.h.

{ return _numIter; }

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

inline

Definition at line 135 of file Statistics.h.

{ return _numSigmaClip; }

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

inline

Definition at line 140 of file Statistics.h.

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

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

inline

Definition at line 141 of file Statistics.h.

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

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

inline

Examples:

imageStatistics.cc.

Definition at line 146 of file Statistics.h.

{ _andMask = andMask; }

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

inline

Definition at line 150 of file Statistics.h.

                                                                        {
        _calcErrorFromInputVariance = calcErrorFromInputVariance;
    }

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

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 699 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;
}

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

inline

Examples:

imageStatistics.cc.

Definition at line 148 of file Statistics.h.

{ _isNanSafe = isNanSafe; }

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

inline

Definition at line 147 of file Statistics.h.

{ _noGoodPixelsMask = noGoodPixelsMask; }

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

inline

Examples:

imageStatistics.cc.

Definition at line 145 of file Statistics.h.

{ assert(numIter > 0); _numIter = numIter; }

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

inline

Examples:

imageStatistics.cc.

Definition at line 144 of file Statistics.h.

{ assert(numSigmaClip > 0); _numSigmaClip = numSigmaClip; }

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

inline

Examples:

imageStatistics.cc.

Definition at line 149 of file Statistics.h.

{ _useWeights = useWeights ? WEIGHTS_TRUE : WEIGHTS_FALSE; }

Friends And Related Function Documentation

friend class Statistics

friend

Definition at line 156 of file Statistics.h.

Member Data Documentation

int lsst::afw::math::StatisticsControl::_andMask

private

Definition at line 160 of file Statistics.h.

bool lsst::afw::math::StatisticsControl::_calcErrorFromInputVariance

private

Definition at line 164 of file Statistics.h.

bool lsst::afw::math::StatisticsControl::_isNanSafe

private

Definition at line 162 of file Statistics.h.

std::vector<double> lsst::afw::math::StatisticsControl::_maskPropagationThresholds

private

Definition at line 165 of file Statistics.h.

int lsst::afw::math::StatisticsControl::_noGoodPixelsMask

private

Definition at line 161 of file Statistics.h.

int lsst::afw::math::StatisticsControl::_numIter

private

Definition at line 159 of file Statistics.h.

double lsst::afw::math::StatisticsControl::_numSigmaClip

private

Definition at line 158 of file Statistics.h.

WeightsBoolean lsst::afw::math::StatisticsControl::_useWeights

private

Definition at line 163 of file Statistics.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/Statistics.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/Statistics.cc