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)

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

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
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)
    {
        try {
            _noGoodPixelsMask = lsst::afw::image::Mask<>::getPlaneBitMask("EDGE");
        } catch(lsst::pex::exceptions::InvalidParameterError) {
            ;                           // Mask has no EDGE plane defined
        }

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

Member Function Documentation

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

inline

Definition at line 126 of file Statistics.h.

{ return _andMask; }

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

inline

Definition at line 131 of file Statistics.h.

{ return _calcErrorFromInputVariance; }

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

inline

Definition at line 128 of file Statistics.h.

{ return _isNanSafe; }

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

inline

Definition at line 127 of file Statistics.h.

{ return _noGoodPixelsMask; }

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

inline

Definition at line 125 of file Statistics.h.

{ return _numIter; }

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

inline

Definition at line 124 of file Statistics.h.

{ return _numSigmaClip; }

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

inline

Definition at line 129 of file Statistics.h.

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

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

inline

Definition at line 130 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 135 of file Statistics.h.

{ _andMask = andMask; }

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

inline

Definition at line 139 of file Statistics.h.

                                                                        {
        _calcErrorFromInputVariance = calcErrorFromInputVariance;
    }

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

inline

Examples:

imageStatistics.cc.

Definition at line 137 of file Statistics.h.

{ _isNanSafe = isNanSafe; }

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

inline

Definition at line 136 of file Statistics.h.

{ _noGoodPixelsMask = noGoodPixelsMask; }

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

inline

Examples:

imageStatistics.cc.

Definition at line 134 of file Statistics.h.

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

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

inline

Examples:

imageStatistics.cc.

Definition at line 133 of file Statistics.h.

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

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

inline

Examples:

imageStatistics.cc.

Definition at line 138 of file Statistics.h.

{ _useWeights = useWeights ? WEIGHTS_TRUE : WEIGHTS_FALSE; }

Member Data Documentation

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

private

Definition at line 146 of file Statistics.h.

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

private

Definition at line 150 of file Statistics.h.

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

private

Definition at line 148 of file Statistics.h.

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

private

Definition at line 147 of file Statistics.h.

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

private

Definition at line 145 of file Statistics.h.

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

private

Definition at line 144 of file Statistics.h.

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

private

Definition at line 149 of file Statistics.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/math/Statistics.h