Class StatisticsControl

• Defined in File Statistics.h

Class Documentation

class StatisticsControl

Pass parameters to a Statistics object

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

Unnamed Group

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)

Public Types

enum WeightsBoolean

Values:

WEIGHTS_FALSE = 0

WEIGHTS_TRUE = 1

WEIGHTS_NONE

Public Functions

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

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)

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)