casa::Vi2ChunkDataProvider< DataIterator, MaskIterator, WeightsIterator > Class Template Reference

Data provider template class backed by VisibilityIterator2 instances. More...

#include <Vi2ChunkDataProvider.h>

Public Types
typedef DataIterator::AccumType	AccumType
	Define typedefs for some template parameters.
typedef DataIterator	DataIteratorType
typedef MaskIterator	MaskIteratorType
typedef WeightsIterator	WeightsIteratorType
Public Member Functions
	Vi2ChunkDataProvider (vi::VisibilityIterator2 *vi2, vi::VisBufferComponent2 component, Bool omit_flagged_data, Bool use_data_weights)
	Vi2ChunkDataProvider (Vi2ChunkDataProvider &&other)
Vi2ChunkDataProvider &	operator= (Vi2ChunkDataProvider &&other)
void	operator++ ()
	Increment the data provider to the next sub-chunk.
Bool	atEnd () const
	Are there any sub-chunks left to provide?
void	finalize ()
	Take any actions necessary to finalize the provider.
uInt64	getCount ()
DataIterator	getData ()
	Get the current sub-chunk.
uInt	getStride ()
Bool	hasMask () const
MaskIterator	getMask ()
	Get the associated mask of the current sub-chunk.
uInt	getMaskStride ()
	Get the stride for the current mask (only called if hasMask() returns True).
Bool	hasWeights () const
WeightsIterator	getWeights ()
	Get the associated weights of the current sub-chunk.
Bool	hasRanges () const
DataRanges	getRanges ()
	Get the associated range(s) of the current sub-chunk.
Bool	isInclude () const
	If the associated data set has ranges, are these include (return True) or exclude (return False) ranges?
void	reset ()
	Reset the provider to point to the first sub-chunk.
void	foreachChunk (StatisticsAlgorithm< AccumType, DataIteratorType, MaskIteratorType, WeightsIteratorType > &statistics, Vi2ChunkStatisticsIteratee< DataIterator, WeightsIterator, MaskIterator > &iteratee)
Public Attributes
std::unique_ptr < vi::VisibilityIterator2 >	vi2
Protected Attributes
vi::VisBufferComponent2	component
std::unique_ptr< const DataIterator >	data_iterator
const Bool	use_data_weights
std::unique_ptr< const WeightsIterator >	weights_iterator
const Bool	omit_flagged_data
std::unique_ptr< const MaskIterator >	mask_iterator
Private Member Functions
void	reset_iterators ()
virtual const Array< typename DataIterator::DataType > &	dataArray ()=0

Detailed Description

template<class DataIterator, class MaskIterator, class WeightsIterator>
class casa::Vi2ChunkDataProvider< DataIterator, MaskIterator, WeightsIterator >

Data provider template class backed by VisibilityIterator2 instances.

These data providers operate on a single MS column over all vi2 sub-chunks in the chunk selected when the data provider is instantiated. In other words, the data sample for statistics generated with a Vi2ChunkDataProvider instance is the data from a single column in a single vi2 chunk. It is intended that the user set up the VisibilityIterator2 appropriately to select the desired data sample for computing statistics. The user may then iterate through the VisibilityIterator2 chunks, calling reset() on the Vi2ChunkDataProvider instance before supplying the instance to the Statistics::setDataProvider() call to compute statistics for that chunk's data. In outline:

Vi2ChunkDataProvider *dp; // given StatisticsAlgorithm statistics; // given for (dp->vi2->originChunks(); dp->vi2->moreChunks(); dp->vi2->nextChunk()) { Prepare the data provider dp->vi2->origin(); dp->reset(); Compute statistics for this chunk statistics.setDataProvider(dp); doStuff(statistics); // do something with the statistics; maybe call statistics.getStatistics() }

The above pattern is encapsulated by the Vi2ChunkDataProvider::foreachChunk() method and Vi2ChunkStatisticsIteratee. The above can be implemented as follows (but with template parameters where needed):

Vi2ChunkDataProvider *dp; // given StatisticsAlgorithm statistics; // given class DoStuff : public Vi2ChunkStatisticsIteratee { ... // constructor, probably needs some sort of accumulator void nextChunk(StatisticsAlgorithm stats, const * VisBuffer2 vb) { stats.getStatistics()...; } } DoStuff doStuff; dp->foreachChunk(statistics, doStuff);

Note that the AccumType template parameter value of StatsDataProvider is derived from the DataIterator parameter value of this template, imposing a constraint on the classes that can be used for DataIterator.

Definition at line 92 of file Vi2ChunkDataProvider.h.