Vi2StatisticsIteratee.h

Go to the documentation of this file.

// -*- mode: c++ -*-
#ifndef VI2_STATISTICS_ITERATEE_H_
#define VI2_STATISTICS_ITERATEE_H_

#include <msvis/MSVis/VisBuffer2.h>
#include <casacore/scimath/StatsFramework/StatisticsAlgorithm.h>
#include <unordered_map>

namespace casa {

// This class is used to encapsulate the action(s) taken on a sequence of
// casacore::StatisticsAlgorithm instances that are generated by the
// Vi2DataProvider::foreachDataset() method, which can be used to compute
// statistics for each dataset of possibly merged casacore::MS chunks provided by
// a VisibilityIterator2 instance. See the Vi2DataProvider.h file for an
// outline of how this class may be used.

template <class DataIterator, class WeightsIterator, class MaskIterator>
class Vi2StatisticsIteratee {

        typedef typename DataIterator::AccumType AccumType;

public:

        // This method will be called by Vi2DataProvider::foreachDataset() for each
        // dataset composed of one or more chunks provided by a VisibilityIterator2
        // instance, with the casacore::StatisticsAlgorithm instance initialized
        // with a data provider for the dataset.
        virtual void nextDataset(
                casacore::StatisticsAlgorithm<AccumType,DataIterator,MaskIterator,WeightsIterator> &stats,
                const std::unordered_map<int,std::string> *columnValues) = 0;
};

} // namespace casa

#endif // VI2_STATISTICS_ITERATEE_H_