casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casa::Vi2ModelVisDataProvider< DataIterator > Class Template Referencefinal

casacore::Template class for model visibilities data provider. More...

#include <Vi2ModelVisDataProvider.h>

Inheritance diagram for casa::Vi2ModelVisDataProvider< DataIterator >:
casa::Vi2DataProvider< DataIterator, MaskIterator, WeightsIterator > casacore::StatsDataProvider< DataIterator::AccumType, DataIterator, MaskIterator, WeightsIterator >

Public Member Functions

 Vi2ModelVisDataProvider (vi::VisibilityIterator2 *vi2, const std::set< casacore::MSMainEnums::PredefinedColumns > &mergedColumns, casacore::Bool omit_flagged_data, casacore::Bool use_data_weights)
 
const casacore::Cube
< casacore::Complex > & 
dataArray ()
 
- Public Member Functions inherited from casa::Vi2DataProvider< DataIterator, MaskIterator, WeightsIterator >
 Vi2DataProvider (vi::VisibilityIterator2 *vi2, const std::set< casacore::MSMainEnums::PredefinedColumns > &mergedColumns_, vi::VisBufferComponent2 component, casacore::Bool omit_flagged_data, casacore::Bool use_data_weights)
 
 Vi2DataProvider (Vi2DataProvider &&other)
 
Vi2DataProvideroperator= (Vi2DataProvider &&other)
 
void operator++ ()
 Increment the data provider to the sub-chunk within the dataset. More...
 
casacore::Bool atEnd () const
 Is this the last sub-chunk within the dataset? More...
 
void finalize ()
 Take any actions necessary to finalize the provider. More...
 
casacore::uInt64 getCount ()
 get the count of elements in the current data set. More...
 
DataIterator getData ()
 Get the current sub-chunk. More...
 
casacore::uInt getStride ()
 Get the stride for the current data set. More...
 
casacore::Bool hasMask () const
 Does the current data set have an associated mask? More...
 
MaskIterator getMask ()
 Get the associated mask of the current sub-chunk. More...
 
casacore::uInt getMaskStride ()
 Get the stride for the current mask (only called if hasMask() returns true). More...
 
casacore::Bool hasWeights () const
 Does the current data set have associated weights? More...
 
WeightsIterator getWeights ()
 Get the associated weights of the current sub-chunk. More...
 
casacore::Bool hasRanges () const
 Does the current data set have associated range(s)? More...
 
DataRanges getRanges ()
 Get the associated range(s) of the current sub-chunk. More...
 
casacore::Bool isInclude () const
 If the associated data set has ranges, are these include (return true) or exclude (return false) ranges? More...
 
void reset ()
 Reset the provider to point to the first sub-chunk of the dataset. More...
 
void foreachDataset (casacore::StatisticsAlgorithm< AccumType, DataIteratorType, MaskIteratorType, WeightsIteratorType > &statistics, Vi2StatisticsIteratee< DataIterator, WeightsIterator, MaskIterator > &iteratee)
 
- Public Member Functions inherited from casacore::StatsDataProvider< DataIterator::AccumType, DataIterator, MaskIterator, WeightsIterator >
virtual ~StatsDataProvider ()
 
virtual uInt getNMaxThreads () const
 If OpenMP is enabled and statistics methods are being called in a multi-threaded context, get maximum number of threads that should be used. More...
 
virtual void updateMaxPos (const LocationType &)
 In general, unless you are writing statistics algorithm code, you shouldn't need to call these methods. More...
 
virtual void updateMinPos (const LocationType &)
 

Additional Inherited Members

- Public Types inherited from casa::Vi2DataProvider< DataIterator, MaskIterator, WeightsIterator >
typedef DataIterator::AccumType AccumType
 Define typedefs for some template parameters. More...
 
typedef DataIterator DataIteratorType
 
typedef MaskIterator MaskIteratorType
 
typedef WeightsIterator WeightsIteratorType
 
- Protected Member Functions inherited from casacore::StatsDataProvider< DataIterator::AccumType, DataIterator, MaskIterator, WeightsIterator >
 StatsDataProvider ()
 
- Protected Attributes inherited from casa::Vi2DataProvider< DataIterator, MaskIterator, WeightsIterator >
std::unique_ptr
< vi::VisibilityIterator2
vi2
 
vi::VisBufferComponent2 component
 
std::unique_ptr< const
DataIterator > 
data_iterator
 
const casacore::Bool use_data_weights
 
std::unique_ptr< const
WeightsIterator > 
weights_iterator
 
const casacore::Bool omit_flagged_data
 
std::unique_ptr< const
MaskIterator > 
mask_iterator
 
int datasetIndex
 
unsigned datasetChunkOrigin
 
int followingChunkDatasetIndex
 
unsigned currentChunk
 
std::unordered_set< string > mergedColumns
 

Detailed Description

template<class DataIterator>
class casa::Vi2ModelVisDataProvider< DataIterator >

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).

Definition at line 46 of file Vi2ModelVisDataProvider.h.

Constructor & Destructor Documentation

template<class DataIterator >
casa::Vi2ModelVisDataProvider< DataIterator >::Vi2ModelVisDataProvider ( vi::VisibilityIterator2 vi2,
const std::set< casacore::MSMainEnums::PredefinedColumns > &  mergedColumns,
casacore::Bool  omit_flagged_data,
casacore::Bool  use_data_weights 
)
inline

Definition at line 50 of file Vi2ModelVisDataProvider.h.

References casa::vi::VisibilityCubeModel.

Member Function Documentation

template<class DataIterator >
const casacore::Cube<casacore::Complex>& casa::Vi2ModelVisDataProvider< DataIterator >::dataArray ( )
inlinevirtual

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