casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator > Class Template Reference

Class to calculate statistics in a "classical" sense, ie using accumulators with no special filtering beyond optional range filtering etc. More...

#include <ClassicalStatistics.h>

Inheritance diagram for casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >:

Public Member Functions
	ClassicalStatistics ()
	ClassicalStatistics (const ClassicalStatistics &cs)
	copy semantics More...
virtual	~ClassicalStatistics ()
ClassicalStatistics &	operator= (const ClassicalStatistics &other)
	copy semantics More...
virtual StatisticsAlgorithm < CASA_STATP > *	clone () const
	Clone this instance. More...
virtual StatisticsData::ALGORITHM	algorithm () const
	get the algorithm that this object uses for computing stats More...
virtual AccumType	getMedian (CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< AccumType > knownMin=nullptr, CountedPtr< AccumType > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)
	In the following group of methods, if the size of the composite dataset is smaller than binningThreshholdSizeBytes, the composite dataset will be (perhaps partially) sorted and persisted in memory during the call. More...
virtual AccumType	getMedianAndQuantiles (std::map< Double, AccumType > &quantiles, const std::set< Double > &fractions, CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< AccumType > knownMin=nullptr, CountedPtr< AccumType > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)
	If one needs to compute both the median and quantile values, it is better to call getMedianAndQuantiles() rather than getMedian() and getQuantiles() separately, as the first will scan large data sets fewer times than calling the separate methods. More...
virtual AccumType	getMedianAbsDevMed (CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< AccumType > knownMin=nullptr, CountedPtr< AccumType > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)
	get the median of the absolute deviation about the median of the data. More...
virtual std::map< Double, AccumType >	getQuantiles (const std::set< Double > &fractions, CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< AccumType > knownMin=nullptr, CountedPtr< AccumType > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)
	Get the specified quantiles. More...
virtual void	getMinMax (AccumType &mymin, AccumType &mymax)
	scan the dataset(s) that have been added, and find the min and max. More...
virtual void	getMinMaxNpts (uInt64 &npts, AccumType &mymin, AccumType &mymax)
virtual uInt64	getNPts ()
	scan the dataset(s) that have been added, and find the number of good points. More...
virtual std::pair< Int64, Int64 >	getStatisticIndex (StatisticsData::STATS stat)
	see base class description More...
virtual void	reset ()
	reset object to initial state. More...
virtual void	setCalculateAsAdded (Bool c)
	Should statistics be updated with calls to addData or should they only be calculated upon calls to getStatistics() etc? Beware that calling this will automatically reinitialize the object, so that it will contain no references to data et al. More...
virtual void	setDataProvider (StatsDataProvider< CASA_STATP > *dataProvider)
	An exception will be thrown if setCalculateAsAdded(True) has been called. More...
void	setQuantileComputer (CountedPtr< ClassicalQuantileComputer< CASA_STATP >> qc)
	Allow derived objects to set the quantile computer object. More...
virtual void	setStatsToCalculate (std::set< StatisticsData::STATS > &stats)
	Provide guidance to algorithms by specifying a priori which statistics the caller would like calculated. More...
Public Member Functions inherited from casacore::StatisticsAlgorithm< CASA_STATP >
virtual	~StatisticsAlgorithm ()
void	addData (const DataIterator &first, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False)
	Add a dataset to an existing set of datasets on which statistics are to be calculated. More...
void	addData (const DataIterator &first, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False)
void	addData (const DataIterator &first, const const Bool *&maskFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	addData (const DataIterator &first, const const Bool *&maskFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	addData (const DataIterator &first, const DataIterator &weightFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False)
void	addData (const DataIterator &first, const DataIterator &weightFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False)
void	addData (const DataIterator &first, const DataIterator &weightFirst, const const Bool *&maskFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	addData (const DataIterator &first, const DataIterator &weightFirst, const const Bool *&maskFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
virtual CASA_STATP	getMedian (CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< CASA_STATP > knownMin=nullptr, CountedPtr< CASA_STATP > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)=0
virtual CASA_STATP	getMedianAndQuantiles (std::map< Double, CASA_STATP > &quantileToValue, const std::set< Double > &quantiles, CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< CASA_STATP > knownMin=nullptr, CountedPtr< CASA_STATP > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)=0
	The return value is the median; the quantiles are returned in the quantileToValue map. More...
virtual CASA_STATP	getMedianAbsDevMed (CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< CASA_STATP > knownMin=nullptr, CountedPtr< CASA_STATP > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)=0
	get the median of the absolute deviation about the median of the data. More...
CASA_STATP	getQuantile (Double quantile, CountedPtr< uInt64 > knownNpts=nullptr, CountedPtr< CASA_STATP > knownMin=nullptr, CountedPtr< CASA_STATP > knownMax=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)
	Purposefully not virtual. More...
virtual std::map< Double, CASA_STATP >	getQuantiles (const std::set< Double > &quantiles, CountedPtr< uInt64 > npts=nullptr, CountedPtr< CASA_STATP > min=nullptr, CountedPtr< CASA_STATP > max=nullptr, uInt binningThreshholdSizeBytes=4096 *4096, Bool persistSortedArray=False, uInt nBins=10000)=0
	get a map of quantiles to values. More...
CASA_STATP	getStatistic (StatisticsData::STATS stat)
	get the value of the specified statistic. More...
StatsData< CASA_STATP >	getStatistics ()
	Return statistics. More...
void	setData (const DataIterator &first, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False)
	setdata() clears any current datasets or data provider and then adds the specified data set as the first dataset in the (possibly new) set of data sets for which statistics are to be calculated. More...
void	setData (const DataIterator &first, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False)
void	setData (const DataIterator &first, const const Bool *&maskFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	setData (const DataIterator &first, const const Bool *&maskFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	setData (const DataIterator &first, const DataIterator &weightFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False)
void	setData (const DataIterator &first, const DataIterator &weightFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False)
void	setData (const DataIterator &first, const DataIterator &weightFirst, const const Bool *&maskFirst, uInt nr, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)
void	setData (const DataIterator &first, const DataIterator &weightFirst, const const Bool *&maskFirst, uInt nr, const DataRanges &dataRanges, Bool isInclude=True, uInt dataStride=1, Bool nrAccountsForStride=False, uInt maskStride=1)

Protected Member Functions
	ClassicalStatistics (CountedPtr< ClassicalQuantileComputer< CASA_STATP > > qc)
	This constructor should be used by derived objects in order to set the proper quantile computer object. More...
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, uInt64 nr, uInt dataStride) const
	scan through the data set to determine the number of good (unmasked, weight > 0, within range) points. More...
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_accumNpts (uInt64 &npts, const DataIterator &dataBegin, const WeightsIterator &weightBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
void	_accumulate (StatsData< AccumType > &stats, const AccumType &datum, const LocationType &location)
void	_accumulate (StatsData< AccumType > &stats, const AccumType &datum, const AccumType &weight, const LocationType &location)
void	_addData ()
	Allows derived classes to do things after data is set or added. More...
void	_clearStats ()
Bool	_getDoMaxMin () const
virtual StatsData< AccumType >	_getInitialStats () const
virtual AccumType	_getStatistic (StatisticsData::STATS stat)
virtual StatsData< AccumType >	_getStatistics ()
virtual StatsData< AccumType > &	_getStatsData ()
	Retrieve stats structure. More...
virtual const StatsData < AccumType > &	_getStatsData () const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMax (CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride) const
	Sometimes we want the min, max, and npts all in one scan. More...
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude) const
virtual void	_minMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymin, CountedPtr< AccumType > &mymax, const DataIterator &dataBegin, const WeightsIterator &weightBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride) const
CountedPtr < StatisticsAlgorithmQuantileComputer < CASA_STATP > >	_getQuantileComputer ()
virtual void	_unweightedStats (StatsData< AccumType > &stats, uInt64 &ngood, LocationType &location, const DataIterator &dataBegin, uInt64 nr, uInt dataStride)
	no weights, no mask, no ranges More...
virtual void	_unweightedStats (StatsData< AccumType > &stats, uInt64 &ngood, LocationType &location, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude)
	no weights, no mask More...
virtual void	_unweightedStats (StatsData< AccumType > &stats, uInt64 &ngood, LocationType &location, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride)
virtual void	_unweightedStats (StatsData< AccumType > &stats, uInt64 &ngood, LocationType &location, const DataIterator &dataBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude)
virtual void	_updateDataProviderMaxMin (const StatsData< AccumType > &threadStats)
virtual void	_weightedStats (StatsData< AccumType > &stats, LocationType &location, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride)
	has weights, but no mask, no ranges More...
virtual void	_weightedStats (StatsData< AccumType > &stats, LocationType &location, const DataIterator &dataBegin, const WeightsIterator &weightsBegin, uInt64 nr, uInt dataStride, const DataRanges &ranges, Bool isInclude)
virtual void	_weightedStats (StatsData< AccumType > &stats, LocationType &location, const DataIterator &dataBegin, const WeightsIterator &weightBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride)
virtual void	_weightedStats (StatsData< AccumType > &stats, LocationType &location, const DataIterator &dataBegin, const WeightsIterator &weightBegin, uInt64 nr, uInt dataStride, const MaskIterator &maskBegin, uInt maskStride, const DataRanges &ranges, Bool isInclude)
Protected Member Functions inherited from casacore::StatisticsAlgorithm< CASA_STATP >
	StatisticsAlgorithm ()
	StatisticsAlgorithm (const StatisticsAlgorithm &other)
	use copy semantics, except for the data provider which uses reference semantics More...
StatisticsAlgorithm &	operator= (const StatisticsAlgorithm &other)
	use copy semantics, except for the data provider which uses reference semantics More...
const StatisticsDataset < CASA_STATP > &	_getDataset () const
	These methods are purposefully not virtual. More...
StatisticsDataset< CASA_STATP > &	_getDataset ()
const std::set < StatisticsData::STATS >	_getStatsToCalculate () const
virtual const std::set < StatisticsData::STATS > &	_getUnsupportedStatistics () const
void	_setUnsupportedStatistics (const std::set< StatisticsData::STATS > &stats)
	Derived classes should normally call this in their constructors, if applicable. More...

Private Types
using	ChunkType = typename StatisticsDataset< CASA_STATP >::ChunkData

Private Member Functions
void	_computeMinMax (CountedPtr< AccumType > &mymax, CountedPtr< AccumType > &mymin, DataIterator dataIter, MaskIterator maskIter, WeightsIterator weightsIter, uInt64 dataCount, const ChunkType &chunk)
void	_computeMinMaxNpts (uInt64 &npts, CountedPtr< AccumType > &mymax, CountedPtr< AccumType > &mymin, DataIterator dataIter, MaskIterator maskIter, WeightsIterator weightsIter, uInt64 dataCount, const ChunkType &chunk)
void	_computeNpts (uInt64 &npts, DataIterator dataIter, MaskIterator maskIter, WeightsIterator weightsIter, uInt64 dataCount, const ChunkType &chunk)
void	_computeStats (StatsData< AccumType > &stats, uInt64 &ngood, LocationType &location, DataIterator dataIter, MaskIterator maskIter, WeightsIterator weightsIter, uInt64 count, const ChunkType &chunk)
void	_doMinMax (AccumType &vmin, AccumType &vmax)
	scan dataset(s) to find min and max More...
uInt64	_doMinMaxNpts (AccumType &vmin, AccumType &vmax)
uInt64	_doNpts ()
void	_doNptsMinMax (uInt64 &mynpts, AccumType &mymin, AccumType &mymax, CountedPtr< uInt64 > knownNpts, CountedPtr< AccumType > knownMin, CountedPtr< AccumType > knownMax)
	for quantile computations, if necessary, determines npts, min, max to send to quantile calculator methods More...

Private Attributes
StatsData< AccumType >	_statsData
Bool	_calculateAsAdded
Bool	_doMaxMin
Bool	_mustAccumulate
CountedPtr < ClassicalQuantileComputer < CASA_STATP > >	_qComputer

Detailed Description

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>
class casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >

Class to calculate statistics in a "classical" sense, ie using accumulators with no special filtering beyond optional range filtering etc.

setCalculateAsAdded() allows one to specify if statistics should be calculated and updated on upon each call to set/addData(). If False, statistics will be calculated only when getStatistic(), getStatistics(), or similar statistics computing methods are called. Setting this value to True allows the caller to not have to keep all the data accessible at once. Note however, that all data must be simultaneously accessible if quantile-like (eg median) calculations are desired.

Objects of this class are instantiated using a ClassicalQuantileComputer object for computation of quantile-like statistics. See the documentation of StatisticsAlgorithm for details relating QuantileComputer classes.

Definition at line 63 of file ClassicalStatistics.h.

Member Typedef Documentation

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

using casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::ChunkType = typename StatisticsDataset<CASA_STATP>::ChunkData

private

Definition at line 66 of file ClassicalStatistics.h.

Constructor & Destructor Documentation

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::ClassicalStatistics

(

)

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::ClassicalStatistics

(

const ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator > &

cs

)

copy semantics

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::~ClassicalStatistics ( )

virtual

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::ClassicalStatistics ( CountedPtr< ClassicalQuantileComputer< CASA_STATP > >  qc )

protected

This constructor should be used by derived objects in order to set the proper quantile computer object.

Member Function Documentation

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

scan through the data set to determine the number of good (unmasked, weight > 0, within range) points.

The first with no mask, no ranges, and no weights is trivial with npts = nr in this class, but is implemented here so that derived classes may override it.

Reimplemented in casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< CASA_STATP >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< CASA_STATP >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumNpts ( uInt64 &  npts, const DataIterator &  dataBegin, const WeightsIterator &  weightBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumulate ( StatsData< AccumType > &  stats, const AccumType &  datum, const LocationType &  location  )

inlineprotected

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_accumulate ( StatsData< AccumType > &  stats, const AccumType &  datum, const AccumType &  weight, const LocationType &  location  )

inlineprotected

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_addData ( )

protectedvirtual

Allows derived classes to do things after data is set or added.

Default implementation does nothing.

Reimplemented from casacore::StatisticsAlgorithm< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_clearStats ( )

protected

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_computeMinMax ( CountedPtr< AccumType > &  mymax, CountedPtr< AccumType > &  mymin, DataIterator  dataIter, MaskIterator  maskIter, WeightsIterator  weightsIter, uInt64  dataCount, const ChunkType &  chunk  )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_computeMinMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymax, CountedPtr< AccumType > &  mymin, DataIterator  dataIter, MaskIterator  maskIter, WeightsIterator  weightsIter, uInt64  dataCount, const ChunkType &  chunk  )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_computeNpts ( uInt64 &  npts, DataIterator  dataIter, MaskIterator  maskIter, WeightsIterator  weightsIter, uInt64  dataCount, const ChunkType &  chunk  )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_computeStats ( StatsData< AccumType > &  stats, uInt64 &  ngood, LocationType &  location, DataIterator  dataIter, MaskIterator  maskIter, WeightsIterator  weightsIter, uInt64  count, const ChunkType &  chunk  )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_doMinMax ( AccumType &  vmin, AccumType &  vmax  )

private

scan dataset(s) to find min and max

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

uInt64 casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_doMinMaxNpts ( AccumType &  vmin, AccumType &  vmax  )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

uInt64 casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_doNpts ( )

private

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_doNptsMinMax ( uInt64 &  mynpts, AccumType &  mymin, AccumType &  mymax, CountedPtr< uInt64 >  knownNpts, CountedPtr< AccumType >  knownMin, CountedPtr< AccumType >  knownMax  )

private

for quantile computations, if necessary, determines npts, min, max to send to quantile calculator methods

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

Bool casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getDoMaxMin ( ) const

inlineprotected

Definition at line 301 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual StatsData<AccumType> casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getInitialStats ( ) const

protectedvirtual

Reimplemented in casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

CountedPtr<StatisticsAlgorithmQuantileComputer<CASA_STATP> > casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getQuantileComputer ( )

inlineprotected

Definition at line 426 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual AccumType casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getStatistic ( StatisticsData::STATS  stat )

protectedvirtual

Implements casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual StatsData<AccumType> casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getStatistics ( )

protectedvirtual

Implements casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< CASA_STATP >, casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual StatsData<AccumType>& casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getStatsData ( )

inlineprotectedvirtual

Retrieve stats structure.

Allows derived classes to maintain their own StatsData structs.

Reimplemented in casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

Definition at line 311 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual const StatsData<AccumType>& casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_getStatsData ( ) const

inlineprotectedvirtual

Reimplemented in casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

Definition at line 313 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMax ( CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

Sometimes we want the min, max, and npts all in one scan.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_minMaxNpts ( uInt64 &  npts, CountedPtr< AccumType > &  mymin, CountedPtr< AccumType > &  mymax, const DataIterator &  dataBegin, const WeightsIterator &  weightBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  ) const

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_unweightedStats ( StatsData< AccumType > &  stats, uInt64 &  ngood, LocationType &  location, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride  )

protectedvirtual

no weights, no mask, no ranges

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_unweightedStats ( StatsData< AccumType > &  stats, uInt64 &  ngood, LocationType &  location, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  )

protectedvirtual

no weights, no mask

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_unweightedStats ( StatsData< AccumType > &  stats, uInt64 &  ngood, LocationType &  location, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  )

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_unweightedStats ( StatsData< AccumType > &  stats, uInt64 &  ngood, LocationType &  location, const DataIterator &  dataBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  )

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_updateDataProviderMaxMin ( const StatsData< AccumType > &  threadStats )

protectedvirtual

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_weightedStats ( StatsData< AccumType > &  stats, LocationType &  location, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride  )

protectedvirtual

has weights, but no mask, no ranges

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_weightedStats ( StatsData< AccumType > &  stats, LocationType &  location, const DataIterator &  dataBegin, const WeightsIterator &  weightsBegin, uInt64  nr, uInt  dataStride, const DataRanges &  ranges, Bool  isInclude  )

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_weightedStats ( StatsData< AccumType > &  stats, LocationType &  location, const DataIterator &  dataBegin, const WeightsIterator &  weightBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride  )

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_weightedStats ( StatsData< AccumType > &  stats, LocationType &  location, const DataIterator &  dataBegin, const WeightsIterator &  weightBegin, uInt64  nr, uInt  dataStride, const MaskIterator &  maskBegin, uInt  maskStride, const DataRanges &  ranges, Bool  isInclude  )

protectedvirtual

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual StatisticsData::ALGORITHM casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::algorithm ( ) const

inlinevirtual

get the algorithm that this object uses for computing stats

Implements casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ChauvenetCriterionStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

Definition at line 84 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual StatisticsAlgorithm<CASA_STATP>* casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::clone ( ) const

virtual

Clone this instance.

Implements casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ChauvenetCriterionStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual AccumType casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getMedian ( CountedPtr< uInt64 >  knownNpts = nullptr, CountedPtr< AccumType >  knownMin = nullptr, CountedPtr< AccumType >  knownMax = nullptr, uInt  binningThreshholdSizeBytes = 4096 *4096, Bool  persistSortedArray = False, uInt  nBins = 10000  )

virtual

In the following group of methods, if the size of the composite dataset is smaller than binningThreshholdSizeBytes, the composite dataset will be (perhaps partially) sorted and persisted in memory during the call.

In that case, and if persistSortedArray is True, this sorted array will remain in memory after the call and will be used on subsequent calls of this method when binningThreshholdSizeBytes is greater than the size of the composite dataset. If persistSortedArray is False, the sorted array will not be stored after this call completes and so any subsequent calls for which the dataset size is less than binningThreshholdSizeBytes, the dataset will be sorted from scratch. Values which are not included due to non-unity strides, are not included in any specified ranges, are masked, or have associated weights of zero are not considered as dataset members for quantile computations. If one has a priori information regarding the number of points (npts) and/or the minimum and maximum values of the data set, these can be supplied to improve performance. Note however, that if these values are not correct, the resulting median and/or quantile values will also not be correct (although see the following notes regarding max/min). Note that if this object has already had getStatistics() called, and the min and max were calculated, there is no need to pass these values in as they have been stored internally and used (although passing them in shouldn't hurt anything). If provided, npts, the number of points falling in the specified ranges which are not masked and have weights > 0, should be exactly correct. min can be less than the true minimum, and max can be greater than the True maximum, but for best performance, these should be as close to the actual min and max as possible. In order for quantile computations to occur over multiple datasets, all datasets must be available. This means that if setCalculateAsAdded() was previously called by passing in a value of True, these methods will throw an exception as the previous call indicates that there is no guarantee that all datasets will be available. If one uses a data provider (by having called setDataProvider()), then this should not be an issue.

Get the median of the distribution. For a dataset with an odd number of good points, the median is just the value at index int(N/2) in the equivalent sorted dataset, where N is the number of points. For a dataset with an even number of points, the median is the mean of the values at indices int(N/2)-1 and int(N/2) in the sorted dataset. nBins is the number of bins, per histogram, to use to bin the data. More bins decrease the likelihood that multiple passes of the data set will be necessary, but also increase the amount of memory used. If nBins is set to less than 1,000, it is automatically increased to 1,000; there should be no reason to ever set nBins to be this small.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual AccumType casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getMedianAbsDevMed ( CountedPtr< uInt64 >  knownNpts = nullptr, CountedPtr< AccumType >  knownMin = nullptr, CountedPtr< AccumType >  knownMax = nullptr, uInt  binningThreshholdSizeBytes = 4096 *4096, Bool  persistSortedArray = False, uInt  nBins = 10000  )

virtual

get the median of the absolute deviation about the median of the data.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual AccumType casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getMedianAndQuantiles ( std::map< Double, AccumType > &  quantiles, const std::set< Double > &  fractions, CountedPtr< uInt64 >  knownNpts = nullptr, CountedPtr< AccumType >  knownMin = nullptr, CountedPtr< AccumType >  knownMax = nullptr, uInt  binningThreshholdSizeBytes = 4096 *4096, Bool  persistSortedArray = False, uInt  nBins = 10000  )

virtual

If one needs to compute both the median and quantile values, it is better to call getMedianAndQuantiles() rather than getMedian() and getQuantiles() separately, as the first will scan large data sets fewer times than calling the separate methods.

The return value is the median; the quantiles are returned in the quantiles map. Values in the fractions set represent the locations in the CDF and should be between 0 and 1, exclusive.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getMinMax ( AccumType &  mymin, AccumType &  mymax  )

virtual

scan the dataset(s) that have been added, and find the min and max.

This method may be called even if setStatsToCaclulate has been called and MAX and MIN has been excluded. If setCalculateAsAdded(True) has previously been called after this object has been (re)initialized, an exception will be thrown. The second version also determines npts in the same scan.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getMinMaxNpts ( uInt64 &  npts, AccumType &  mymin, AccumType &  mymax  )

virtual

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual uInt64 casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getNPts ( )

virtual

scan the dataset(s) that have been added, and find the number of good points.

This method may be called even if setStatsToCaclulate has been called and NPTS has been excluded. If setCalculateAsAdded(True) has previously been called after this object has been (re)initialized, an exception will be thrown.

Reimplemented in casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual std::map<Double, AccumType> casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getQuantiles ( const std::set< Double > &  fractions, CountedPtr< uInt64 >  knownNpts = nullptr, CountedPtr< AccumType >  knownMin = nullptr, CountedPtr< AccumType >  knownMax = nullptr, uInt  binningThreshholdSizeBytes = 4096 *4096, Bool  persistSortedArray = False, uInt  nBins = 10000  )

virtual

Get the specified quantiles.

fractions must be between 0 and 1, noninclusive.

Reimplemented in casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual std::pair<Int64, Int64> casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::getStatisticIndex ( StatisticsData::STATS  stat )

virtual

see base class description

Implements casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::ConstrainedRangeStatistics< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

ClassicalStatistics& casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::operator=

(

const ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator > &

other

)

copy semantics

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::reset ( )

virtual

reset object to initial state.

Clears all private fields including data, accumulators, etc.

Reimplemented from casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ConstrainedRangeStatistics< CASA_STATP >, casacore::ChauvenetCriterionStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::setCalculateAsAdded ( Bool  c )

virtual

Should statistics be updated with calls to addData or should they only be calculated upon calls to getStatistics() etc? Beware that calling this will automatically reinitialize the object, so that it will contain no references to data et al.

after this method has been called.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, casacore::ChauvenetCriterionStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::HingesFencesStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::setDataProvider ( StatsDataProvider< CASA_STATP > *  dataProvider )

virtual

An exception will be thrown if setCalculateAsAdded(True) has been called.

Reimplemented from casacore::StatisticsAlgorithm< CASA_STATP >.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::setQuantileComputer ( CountedPtr< ClassicalQuantileComputer< CASA_STATP >>  qc )

inline

Allow derived objects to set the quantile computer object.

API developers shouldn't need to call this, unless they are writing derived classes of ClassicalStatistics. Purposefully non-virtual. Derived classes should not implement.

Definition at line 221 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

virtual void casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::setStatsToCalculate ( std::set< StatisticsData::STATS > &  stats )

virtual

Provide guidance to algorithms by specifying a priori which statistics the caller would like calculated.

Reimplemented from casacore::StatisticsAlgorithm< CASA_STATP >.

Reimplemented in casacore::BiweightStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >, and casacore::FitToHalfStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >.

Member Data Documentation

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

Bool casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_calculateAsAdded

private

Definition at line 493 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

Bool casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_doMaxMin

private

Definition at line 493 of file ClassicalStatistics.h.

Referenced by casacore::ClassicalStatistics< CASA_STATP >::_getDoMaxMin().

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

Bool casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_mustAccumulate

private

Definition at line 493 of file ClassicalStatistics.h.

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

CountedPtr<ClassicalQuantileComputer<CASA_STATP> > casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_qComputer

private

Definition at line 495 of file ClassicalStatistics.h.

Referenced by casacore::ClassicalStatistics< CASA_STATP >::_getQuantileComputer(), and casacore::ClassicalStatistics< CASA_STATP >::setQuantileComputer().

template<class AccumType, class DataIterator, class MaskIterator = const Bool*, class WeightsIterator = DataIterator>

StatsData<AccumType> casacore::ClassicalStatistics< AccumType, DataIterator, MaskIterator, WeightsIterator >::_statsData

private

Definition at line 492 of file ClassicalStatistics.h.

Referenced by casacore::ClassicalStatistics< CASA_STATP >::_getStatsData().

---

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

• scimath/StatsFramework/ClassicalStatistics.h