// -*- mode: c++ -*-
//# Copyright (C) 1996,1997,1998,1999,2000,2002,2003,2015
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//
// Corrected visibilities data provider template
//
#ifndef MSVIS_STATISTICS_VI2_MODEL_VIS_DATA_PROVIDER_H
#define MSVIS_STATISTICS_VI2_MODEL_VIS_DATA_PROVIDER_H

#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Cube.h>
#include <msvis/MSVis/VisibilityIterator2.h>
#include <msvis/MSVis/VisBufferComponents2.h>
#include <msvis/MSVis/statistics/Vi2DataProvider.h>

namespace casa {

//
// casacore::Template class for model visibilities data provider. "DataIterator" template
// parameter is used to select a transformation for the visibilities (amplitude
// using Vi2StatsAmplitudeIterator, phase using Vi2StatsPhaseIterator, etc).
//
template <class DataIterator>
class Vi2ModelVisDataProvider final
	: public Vi2WeightsCubeDataProvider<DataIterator> {

public:
	Vi2ModelVisDataProvider(
		vi::VisibilityIterator2 *vi2,
		const std::set<casacore::MSMainEnums::PredefinedColumns> &mergedColumns,
		casacore::Bool omit_flagged_data,
		casacore::Bool use_data_weights)
		: Vi2WeightsCubeDataProvider<DataIterator>(
			vi2,
			mergedColumns,
			vi::VisBufferComponent2::VisibilityCubeModel,
			omit_flagged_data,
			use_data_weights) {}

	const casacore::Cube<casacore::Complex>& dataArray() {
		return Vi2WeightsCubeDataProvider<DataIterator>::
			vi2->getVisBuffer()->visCubeModel();
	}
};

} // namespace casa

#endif // MSVIS_STATISTICS_VI2_MODEL_VIS_DATA_PROVIDER_H