lsst.afw  22.0.1-39-g816bf8776+e9ecb060fe
Public Types | Public Member Functions | Friends | List of all members
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. More...
 
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
 
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
 

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 92 of file Statistics.h.

Member Enumeration Documentation

◆ WeightsBoolean

Enumerator
WEIGHTS_FALSE 
WEIGHTS_TRUE 
WEIGHTS_NONE 

Definition at line 94 of file Statistics.h.

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
numSigmaClipnumber of standard deviations to clip at
numIterNumber of iterations
andMaskand-Mask: defines which mask bits cause a value to be ignored
isNanSafeflag NaNs & Infs
useWeightsuse weighted statistics (via a vector or an inverse variance)

Definition at line 96 of file Statistics.h.

Member Function Documentation

◆ getAndMask()

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

Definition at line 134 of file Statistics.h.

◆ getCalcErrorFromInputVariance()

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

Definition at line 139 of file Statistics.h.

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

◆ getNanSafe()

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

Definition at line 136 of file Statistics.h.

◆ getNoGoodPixelsMask()

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

Definition at line 135 of file Statistics.h.

◆ getNumIter()

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

Definition at line 133 of file Statistics.h.

◆ getNumSigmaClip()

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

Definition at line 132 of file Statistics.h.

◆ getWeighted()

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

Definition at line 137 of file Statistics.h.

◆ getWeightedIsSet()

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

Definition at line 138 of file Statistics.h.

◆ setAndMask()

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

Definition at line 155 of file Statistics.h.

◆ setCalcErrorFromInputVariance()

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

Definition at line 159 of file Statistics.h.

◆ setMaskPropagationThreshold()

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

Definition at line 726 of file Statistics.cc.

◆ setNanSafe()

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

Definition at line 157 of file Statistics.h.

◆ setNoGoodPixelsMask()

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

Definition at line 156 of file Statistics.h.

◆ setNumIter()

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

Definition at line 148 of file Statistics.h.

◆ setNumSigmaClip()

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

Definition at line 141 of file Statistics.h.

◆ setWeighted()

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

Definition at line 158 of file Statistics.h.

Friends And Related Function Documentation

◆ Statistics

friend class Statistics
friend

Definition at line 164 of file Statistics.h.


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