casacore::LatticeStatsDataProviderBase< T > Class Template Reference

Abstract base class of data providers which allows stats framework to iterate through a lattice. More...

#include <LatticeStatsDataProviderBase.h>

Inheritance diagram for casacore::LatticeStatsDataProviderBase< T >:

Public Member Functions
virtual	~LatticeStatsDataProviderBase ()
	typedef typename NumericTraits<T>::PrecisionType AccumType;
virtual uInt	estimatedSteps () const =0
	estimated number of steps to iterate through the the lattice
virtual void	finalize ()
	Take any actions necessary to finalize the provider.
uInt	getMaskStride ()
	Get the stride for the current mask (only called if hasMask() returns True).
std::vector< std::pair < typename NumericTraits< T > ::PrecisionType, typename NumericTraits< T > ::PrecisionType > >	getRanges ()
	Get the associated range(s) of the current dataset.
uInt	getStride ()
	Get the stride for the current data set.
const T *	getWeights ()
	Returns NULL; lattices do not have associated weights.
Bool	hasRanges () const
	Does the current data set have associated range(s)?
Bool	hasWeights () const
	returns False; lattices do not have associated weights.
Bool	isInclude () const
	If the associated data set has ranges, are these include (return True) or exclude (return False) ranges?
void	minMaxPos (IPosition &minpos, IPosition &maxpos) const
	get the positions of the min and max
virtual void	reset ()
	reset the provider to point to the first data set it manages.
void	setProgressMeter (CountedPtr< LattStatsProgress > pm)
void	setRanges (const std::vector< std::pair< typename NumericTraits< T >::PrecisionType, typename NumericTraits< T >::PrecisionType > > &ranges, Bool isInclude)
	set the data ranges
Protected Member Functions
	LatticeStatsDataProviderBase ()
void	_updateMaxPos (const IPosition &maxPos)
	virtual uInt _nsteps() const = 0;
void	_updateMinPos (const IPosition &minPos)
void	_updateProgress ()
Private Attributes
Bool	_hasRanges
Bool	_isInclude
std::vector< std::pair < typename NumericTraits< T > ::PrecisionType, typename NumericTraits< T > ::PrecisionType > >	_ranges
CountedPtr< LattStatsProgress >	_progressMeter
IPosition	_minPos
IPosition	_maxPos

Detailed Description

template<class T>
class casacore::LatticeStatsDataProviderBase< T >

Abstract base class of data providers which allows stats framework to iterate through a lattice.

Definition at line 44 of file LatticeStatsDataProviderBase.h.

Constructor & Destructor Documentation

template<class T >

virtual casacore::LatticeStatsDataProviderBase< T >::~LatticeStatsDataProviderBase ( ) [virtual]

typedef typename NumericTraits<T>::PrecisionType AccumType;

template<class T >

casacore::LatticeStatsDataProviderBase< T >::LatticeStatsDataProviderBase ( ) [protected]

Member Function Documentation

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::_updateMaxPos ( const IPosition & maxPos ) [inline, protected]

virtual uInt _nsteps() const = 0;

Definition at line 98 of file LatticeStatsDataProviderBase.h.

References casacore::LatticeStatsDataProviderBase< T >::_maxPos.

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::_updateMinPos ( const IPosition & minPos ) [inline, protected]

Definition at line 100 of file LatticeStatsDataProviderBase.h.

References casacore::LatticeStatsDataProviderBase< T >::_minPos.

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::_updateProgress ( ) [protected]

template<class T >

virtual uInt casacore::LatticeStatsDataProviderBase< T >::estimatedSteps ( ) const [pure virtual]

estimated number of steps to iterate through the the lattice

Implemented in casacore::LatticeStatsDataProvider< T >, and casacore::MaskedLatticeStatsDataProvider< T >.

template<class T >

virtual void casacore::LatticeStatsDataProviderBase< T >::finalize ( ) [virtual]

Take any actions necessary to finalize the provider.

This will be called when atEnd() returns True.

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

Reimplemented in casacore::LatticeStatsDataProvider< T >, and casacore::MaskedLatticeStatsDataProvider< T >.

template<class T >

uInt casacore::LatticeStatsDataProviderBase< T >::getMaskStride ( ) [virtual]

Get the stride for the current mask (only called if hasMask() returns True).

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

std::vector<std::pair<typename NumericTraits<T>::PrecisionType, typename NumericTraits<T>::PrecisionType> > casacore::LatticeStatsDataProviderBase< T >::getRanges ( ) [virtual]

Get the associated range(s) of the current dataset.

Only called if hasRanges() returns True;

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

uInt casacore::LatticeStatsDataProviderBase< T >::getStride ( ) [virtual]

Get the stride for the current data set.

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

const T* casacore::LatticeStatsDataProviderBase< T >::getWeights ( ) [virtual]

Returns NULL; lattices do not have associated weights.

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

Bool casacore::LatticeStatsDataProviderBase< T >::hasRanges ( ) const [virtual]

Does the current data set have associated range(s)?

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

Bool casacore::LatticeStatsDataProviderBase< T >::hasWeights ( ) const [virtual]

returns False; lattices do not have associated weights.

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

Bool casacore::LatticeStatsDataProviderBase< T >::isInclude ( ) const [virtual]

If the associated data set has ranges, are these include (return True) or exclude (return False) ranges?

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::minMaxPos	(	IPosition &	minpos,
		IPosition &	maxpos
	)			const

get the positions of the min and max

template<class T >

virtual void casacore::LatticeStatsDataProviderBase< T >::reset ( ) [virtual]

reset the provider to point to the first data set it manages.

Implements casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >.

Reimplemented in casacore::LatticeStatsDataProvider< T >, and casacore::MaskedLatticeStatsDataProvider< T >.

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::setProgressMeter ( CountedPtr< LattStatsProgress > pm )

template<class T >

void casacore::LatticeStatsDataProviderBase< T >::setRanges	(	const std::vector< std::pair< typename NumericTraits< T >::PrecisionType, typename NumericTraits< T >::PrecisionType > > &	ranges,
		Bool	isInclude
	)