VisibilityIterator2 iterates through one or more readonly MeasurementSets. More...

#include <VisibilityIteratorImpl2.h>

Inheritance diagram for casa::vi::VisibilityIteratorImpl2:

Classes
class	BackWriter
	+========================\| \| \| \| Output Related Methods \| \| \| +========================\| More...
class	BackWriterImpl
	A simple BackWriterImpl2 uses a nullary accessor on a VisBuffer. More...
class	BackWriterImpl2
	BackWriterImpl2 is slightly more complicated in that it uses a unary accessor. More...
class	Cache
	void convertVisFromStokes (const Matrix<CStokesVector> & visibilityStokes, Cube<Complex> & visCube); More...
class	PendingChanges
class	RowBounds
Public Types
typedef VisibilityIterator2::DataColumn	DataColumn
	VLAT should not access private parts, especially variables.
Public Member Functions
	VisibilityIteratorImpl2 (VisibilityIterator2 *rovi, const Block< MeasurementSet > &mss, const Block< Int > &sortColumns, Bool addDefaultSortCols, Double timeInterval, VisBufferType vbType, Bool isWritable)
	class AsyncEnabler { public: AsyncEnabler (VisibilityIterator2 &); AsyncEnabler (VisibilityIterator2 *); ~AsyncEnabler ();
virtual	~VisibilityIteratorImpl2 ()
	// Copy construct.
virtual Bool	isWritable () const
	Members.
virtual void	origin ()
	Reset iterator to origin/start of data (of current chunk)
virtual void	originChunks ()
	Reset iterator to true start of data (first chunk)
virtual Double	getInterval () const
	Return the time interval (in seconds) used for iteration.
virtual void	setInterval (Double timeInterval)
	Set or reset the time interval (in seconds) to use for iteration.
virtual void	setRowBlocking (Int nRows=0)
	Set the 'blocking' size for returning data.
virtual Bool	existsColumn (VisBufferComponent2 id) const
virtual Bool	more () const
	Return False if no more data (in current chunk)
virtual Subchunk	getSubchunkId () const
virtual const Block< Int > &	getSortColumns () const
virtual void	setFrequencySelections (const FrequencySelections &selection)
	Select the channels to be returned.
virtual Bool	moreChunks () const
	Return False if no more 'Chunks' of data left.
virtual Bool	isNewArrayId () const
	Check if ms has change since last iteration.
virtual Bool	isNewFieldId () const
virtual Bool	isNewMs () const
virtual Bool	isNewSpectralWindow () const
virtual Int	msId () const
	reference to actual ms in interator
virtual Int	getNMs () const
virtual VisBuffer2 *	getVisBuffer ()
virtual const MeasurementSet &	ms () const
	reference to actual ms in interator
virtual void	next ()
	advance the iteration
virtual void	nextChunk ()
	Advance to the next Chunk of data.
virtual void	antenna1 (Vector< Int > &ant1) const
	Return antenna1.
virtual void	antenna2 (Vector< Int > &ant2) const
	Return antenna2.
virtual void	feed1 (Vector< Int > &fd1) const
	Return feed1.
virtual void	feed2 (Vector< Int > &fd2) const
	Return feed2.
void	jonesC (Vector< SquareMatrix< Complex, 2 > > &cjones) const
	Return feed configuration matrix for specified antenna.
virtual const Cube< Double > &	receptorAngles () const
	Return receptor angles for all antennae and feeds First axis of the cube is a receptor number, 2nd is antennaId, 3rd is feedId Note: the method is intended to provide an access to MSIter::receptorAngles for VisBuffer in the multi-feed case.
virtual const Vector< String > &	antennaMounts () const
	return a string mount identifier for each antenna
virtual const Cube < RigidVector< Double, 2 > > &	getBeamOffsets () const
	Return a cube containing pairs of coordinate offsets for each receptor of each feed (values are in radians, coordinate system is fixed with antenna and is the same one as used to define the BEAM_OFFSET parameter in the feed table).
virtual Bool	allBeamOffsetsZero () const
	True if all elements of the cube returned by getBeamOffsets are zero.
virtual const Vector< Float > &	feed_pa (Double time) const
	Return feed parallactic angles Vector (nant) (1 feed/ant)
virtual const Float &	parang0 (Double time) const
	Return nominal parallactic angle at specified time (does not include feed position angle offset--see feed_pa) A global value for all antennas (e.g., small array)
virtual const Vector< Float > &	parang (Double time) const
	Per antenna:
virtual MDirection	azel0 (Double time) const
	Return the antenna AZ/EL Vector (nant)
virtual const Vector < MDirection > &	azel (Double time) const
virtual Double	hourang (Double time) const
	Return the hour angle for the specified time.
virtual void	fieldIds (Vector< Int > &) const
	Return the current FieldId.
virtual void	arrayIds (Vector< Int > &) const
	Return the current ArrayId.
virtual String	fieldName () const
	Return the current Field Name.
virtual String	sourceName () const
	Return the current Source Name.
virtual void	flag (Cube< Bool > &flags) const
	Return flag for each polarization, channel and row.
virtual void	flag (Matrix< Bool > &flags) const
	Return flag for each channel & row.
Bool	flagCategoryExists () const
	Determine whether FLAG_CATEGORY is valid.
virtual void	flagCategory (Array< Bool > &flagCategories) const
	Return flags for each polarization, channel, category, and row.
virtual void	flagRow (Vector< Bool > &rowflags) const
	Return row flag.
virtual void	scan (Vector< Int > &scans) const
	Return scan number.
virtual void	observationId (Vector< Int > &obsids) const
	Return the OBSERVATION_IDs.
virtual void	processorId (Vector< Int > &procids) const
	Return the PROCESSOR_IDs.
virtual void	stateId (Vector< Int > &stateids) const
	Return the STATE_IDs.
virtual const MDirection &	phaseCenter () const
	Return the current phase center as an MDirection.
virtual Int	polFrame () const
	Return frame for polarization (returns PolFrame enum)
virtual void	corrType (Vector< Int > &corrTypes) const
	Return the correlation type (returns Stokes enums)
virtual void	sigma (Vector< Float > &sig) const
	Return sigma.
virtual void	sigmaMat (Matrix< Float > &sigmat) const
	Return sigma matrix (pol-dep)
virtual Int	spectralWindow () const
	Return current SpectralWindow.
virtual void	spectralWindows (Vector< Int > &spws) const
virtual Int	polarizationId () const
	Return current Polarization Id.
virtual Int	dataDescriptionId () const
	Return current DataDescription Id.
virtual void	dataDescriptionIds (Vector< Int > &ddis) const
virtual void	time (Vector< Double > &t) const
	Return MJD midpoint of interval.
virtual void	timeCentroid (Vector< Double > &t) const
	Return MJD centroid of interval.
virtual void	timeInterval (Vector< Double > &ti) const
	Return nominal time interval.
virtual void	exposure (Vector< Double > &expo) const
	Return actual time interval.
virtual void	visibilityCorrected (Cube< Complex > &vis) const
	Return the visibilities as found in the MS, Cube (npol,nchan,nrow).
virtual void	visibilityModel (Cube< Complex > &vis) const
virtual void	visibilityObserved (Cube< Complex > &vis) const
virtual void	floatData (Cube< Float > &fcube) const
	Return FLOAT_DATA as a Cube (npol, nchan, nrow) if found in the MS.
virtual IPosition	visibilityShape () const
	Return the visibility 4-vector of polarizations for each channel.
virtual void	uvw (Matrix< Double > &uvwmat) const
	Return u,v and w (in meters)
virtual void	weight (Vector< Float > &wt) const
	Return weight.
virtual void	weightMat (Matrix< Float > &wtmat) const
	Returns the nPol_p x curNumRow_p weight matrix.
Bool	weightSpectrumExists () const
	Determine whether WEIGHT_SPECTRUM exists.
virtual void	weightSpectrum (Cube< Float > &wtsp) const
	Return weightspectrum (a weight for each channel)
const VisImagingWeight &	getImagingWeightGenerator () const
	Return imaging weight (a weight for each channel) virtual Matrix<Float> & imagingWeight (Matrix<Float> & wt) const;.
virtual Bool	newFieldId () const
	Return True if FieldId/Source has changed since last iteration.
virtual Bool	newArrayId () const
	Return True if arrayID has changed since last iteration.
virtual Bool	newSpectralWindow () const
	Return True if SpectralWindow has changed since last iteration.
virtual Int	nRows () const
	Return the number of rows in the current iteration.
virtual void	getRowIds (Vector< uInt > &rowids) const
	Return the row ids as from the original root table.
virtual Int	nRowsInChunk () const
	Return the numbers of rows in the current chunk.
virtual void	slurp () const
	Return the number of sub-intervals in the current chunk.
virtual const vi::SubtableColumns &	subtableColumns () const
	Get the spw, start and nchan for all the ms's is this Visiter that match the frequecy "freqstart-freqStep" and "freqEnd+freqStep" range Can help in doing channel selection above.
virtual const SpectralWindowChannels &	getSpectralWindowChannels (Int msId, Int spectralWindowId) const
	get back the selected spectral windows and spectral channels for current ms
virtual void	useImagingWeight (const VisImagingWeight &imWgt)
	assign a VisImagingWeight object to this iterator
virtual Int	nAntennas () const
	return number of Ant
virtual Int	nRowsViWillSweep () const
	Return number of rows in all selected ms's.
virtual Int	nSpectralWindows () const
	Return number of spws, polids, ddids.
virtual Int	nPolarizations () const
virtual Int	nDataDescriptionIds () const
virtual MEpoch	getEpoch () const
MFrequency::Types	getObservatoryFrequencyType () const
MPosition	getObservatoryPosition () const
Vector< Float >	getReceptor0Angle ()
virtual void	writeFlag (const Matrix< Bool > &flag)
	Write/modify the flags in the data.
virtual void	writeFlag (const Cube< Bool > &flag)
	Write/modify the flags in the data.
virtual void	writeFlagRow (const Vector< Bool > &rowflags)
	Write/modify the flag row column; dimension Vector (nrow)
void	writeFlagCategory (const Array< Bool > &fc)
virtual void	writeVisCorrected (const Cube< Complex > &vis)
	Write/modify the visibilities.
virtual void	writeVisModel (const Cube< Complex > &vis)
virtual void	writeVisObserved (const Cube< Complex > &vis)
virtual void	writeWeight (const Matrix< Float > &wt)
	Write/modify the weights.
virtual void	writeWeightSpectrum (const Cube< Float > &wtsp)
	Write/modify the weightMat virtual void writeWeightMat (const Matrix<Float> & wtmat);.
virtual void	writeSigma (const Matrix< Float > &sig)
	Write/modify the Sigma.
virtual void	writeModel (const RecordInterface &rec, Bool iscomponentlist=True, Bool incremental=False)
	Write/modify the ncorr x nrow SigmaMat.
virtual void	writeBackChanges (VisBuffer2 *)
	+-------------------+ \| \| \| Writeback Methods \| \| \| +-------------------+
Protected Types
typedef Vector< MeasurementSet >	MeasurementSets
Protected Member Functions
void	addDataSelection (const MeasurementSet &ms)
void	allSpectralWindowsSelected (Vector< Int > &spectralWindows, Vector< Int > &nChannels) const
void	attachColumnsSafe (const Table &t)
virtual void	attachColumns (const Table &t)
	attach the column objects to the currently selected table
virtual const Table	attachTable () const
	returns the table, to which columns are attached, can be overridden in derived classes
virtual void	applyPendingChanges ()
virtual void	configureNewChunk ()
	set the iteration state
virtual void	configureNewSubchunk ()
	set the currently selected table
const ChannelSelector *	createDefaultChannelSelector (Double time, Int msId, Int spectralWindowId)
virtual const vi::ChannelSelector *	determineChannelSelection (Double time)
Slice	findChannelsInRange (Double lowerFrequency, Double upperFrequency, const vi::SpectralWindowChannels &spectralWindowChannels)
template<typename T >
void	getColumnRows (const ROArrayColumn< T > &column, Array< T > &array) const
	Methods to get the data out of a table column according to whatever selection criteria (e.g., slicing) is in effect.
template<typename T >
void	getColumnRowsMatrix (const ROArrayColumn< T > &column, Matrix< T > &array) const
template<typename T >
void	getColumnRows (const ROScalarColumn< T > &column, Vector< T > &array) const
Vector< Double >	getFrequencies (Double time, Int frameOfReference) const
Vector< Double >	getFrequencies (Double time, Int frameOfReference, Int spectralWindowId, Int msId) const
Vector< Int >	getChannels (Double time, Int frameOfReference) const
Vector< Int >	getCorrelations () const
Int	getReportingFrameOfReference () const
Vector< MeasurementSet >	getMeasurementSets () const
	Returns the MS objects that this VI is iterating over.
const MSDerivedValues &	getMsd () const
	Provides access to the MS-derived values object.
VisibilityIterator2 *	getViP () const
	Get privileged (non-const) access to the containing ROVI.
virtual void	initialize (const Block< MeasurementSet > &mss)
	void getVisibilityAsStokes (Matrix<CStokesVector> & visibilityStokes, const ROArrayColumn<Complex> & column) const;
Bool	isInASelectedSpectralWindow () const
	Returns true if MS Iterator is currently pointing to a selected spectral window.
vi::ChannelSelector *	makeChannelSelectorC (const FrequencySelection &selection, Double time, Int msId, Int spectralWindowId, Int polarizationId)
	Creates a channel selection for the current subchunk based on the channel or frequency selection made by the user.
vi::ChannelSelector *	makeChannelSelectorF (const FrequencySelection &selection, Double time, Int msId, Int spectralWindowId)
MFrequency::Convert	makeFrequencyConverter (Double time, Int otherFrameOfReference, Bool toObservedFrame) const
const ROMSColumns *	msColumnsKluge () const
	Allow access to the MSColumns object; for use by VisBuffer2Adapter KLUGE
virtual void	originChunks (Bool forceRewind)
	Method to reset the VI back to the start.
void	positionMsIterToASelectedSpectralWindow ()
	Advances the MS Iterator until it points at a spectral window that is part of the frequency selection.
void	setReportingFrameOfReference (Int)
	Sets the default frequency reporting frame of reference.
virtual void	setTileCache ()
	Adjusts the tile cache for some columns so that the cache size is optimized for the current input state (e.g., a new data description).
virtual void	throwIfPendingChanges ()
	Throws exception if there is a pending (i.e., unapplied) change to the VI's properties.
Bool	usesTiledDataManager (const String &columnName, const MeasurementSet &ms) const
	Returns true if the named column uses a tiled data manager in the specified MS.
void	initializeBackWriters ()
template<typename T >
void	putColumnRows (ArrayColumn< T > &column, const Array< T > &array)
template<typename T >
void	putColumnRows (ArrayColumn< T > &column, const Matrix< T > &array)
template<typename T >
void	putColumnRows (ScalarColumn< T > &column, const Vector< T > &array)
Static Protected Member Functions
template<typename Ret >
static BackWriter *	makeBackWriter (void(VisibilityIteratorImpl2::setter)(Ret), Ret(VisBuffer2::getter)() const)
	Backwriter(2) creation methods.
template<typename Ret >
static BackWriter *	makeBackWriter2 (void(VisibilityIteratorImpl2::setter)(Ret, VisibilityIteratorImpl2::DataColumn), Ret(VisBuffer2::getter)() const, VisibilityIterator2::DataColumn dc)
Protected Attributes
std::map< VisBufferComponent2, BackWriter * >	backWriters_p
Cache	cache_p
const ChannelSelector *	channelSelector_p
ChannelSelectorCache *	channelSelectorCache_p
ViColumns2	columns_p
Bool	floatDataFound_p
FrequencySelections *	frequencySelections_p
VisImagingWeight	imwgt_p
MeasurementSets	measurementSets_p
Bool	more_p
Int	msIndex_p
Bool	msIterAtOrigin_p
MSIter	msIter_p
MSDerivedValues	msd_p
Int	nPolarizations_p
Int	nRowBlocking_p
PendingChanges	pendingChanges_p
Int	reportingFrame_p
RowBounds	rowBounds_p
	frame of reference
Block< Int >	sortColumns_p
SpectralWindowChannelsCache *	spectralWindowChannelsCache_p
Subchunk	subchunk_p
SubtableColumns *	subtableColumns_p
Vector< Bool >	tileCacheIsSet_p
Double	timeInterval_p
VisBuffer2 *	vb_p
VisibilityIterator2 *	vi_p
Friends
class	AsyncEnabler
class	ViImplAsync2
class	VisibilityIterator2
class	VLAT
class	VisBuffer2Adapter

Detailed Description

VisibilityIterator2 iterates through one or more readonly MeasurementSets.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

The VisibilityIterator2 is a readonly iterator returning visibilities

Synopsis

VisibilityIterator2 provides iteration with various sort orders for one or more MSs. It has member functions to retrieve the fields commonly needed in synthesis calibration and imaging.

One should use VisBuffer to access chunks of data.

Example

Motivation

For imaging and calibration you need to access an MS in some consistent order (by field, spectralwindow, time interval etc.). This class provides that access.

Thrown Exceptions

To Do

cleanup the currently dual interface for visibilities and flags
sort out what to do with weights when interpolating

Definition at line 115 of file VisibilityIteratorImpl2.h.

Member Typedef Documentation

typedef VisibilityIterator2::DataColumn casa::vi::VisibilityIteratorImpl2::DataColumn

VLAT should not access private parts, especially variables.

enum PolFrame { Circular polarization Circular=0, Linear polarization Linear=1 };

enum DataColumn { Observed data Observed=0, Model data Model, Corrected data Corrected };

Definition at line 144 of file VisibilityIteratorImpl2.h.

typedef Vector<MeasurementSet> casa::vi::VisibilityIteratorImpl2::MeasurementSets [protected]

Definition at line 862 of file VisibilityIteratorImpl2.h.

Constructor & Destructor Documentation

casa::vi::VisibilityIteratorImpl2::VisibilityIteratorImpl2	(	VisibilityIterator2 *	rovi,
		const Block< MeasurementSet > &	mss,
		const Block< Int > &	sortColumns,
		Bool	addDefaultSortCols,
		Double	timeInterval,
		VisBufferType	vbType,
		Bool	isWritable
	)

class AsyncEnabler { public: AsyncEnabler (VisibilityIterator2 &); AsyncEnabler (VisibilityIterator2 *); ~AsyncEnabler ();

           void release ();

       private:

           Bool oldEnabledState_p;
           VisibilityIterator2 * roVisibilityIterator2_p;
       };

    Default constructor - useful only to assign another iterator later

VisibilityIteratorImpl2 ();

    Construct from an MS and a Block of MS column enums specifying the
    iteration order.  If no order is specified, it uses the default sort
    order of MSIter, which is not necessarily the raw order of ms!
    The default ordering is ARRAY_ID, FIELD_ID, DATA_DESC_ID,
    and TIME, but check MSIter.h to be sure.
    These columns will be added first if they are not specified.

    An optional timeInterval (in seconds) can be given to iterate through
    chunks of time.  The default interval of 0 groups all times together.
    Every 'chunk' of data contains all data within a certain time interval and
    with identical values of the other iteration columns (e.g.  DATA_DESC_ID
    and FIELD_ID).  Using selectChannel (), a number of groups of channels can
    be requested.  At present the channel group iteration will always occur
    before the interval iteration.
   VisibilityIteratorImpl (const MeasurementSet & ms,
                               const Block<Int> & sortColumns,
                               Double timeInterval = 0);

    Same as above, but with the option of using the raw order of ms
    (addDefaultSortCols=false).
   VisibilityIteratorImpl (const MeasurementSet & ms,
                               const Block<Int> & sortColumns, const Bool addDefaultSortCols,
                               Double timeInterval = 0);

    Same as previous constructors, but with multiple MSs to iterate over.
   VisibilityIteratorImpl (const Block<MeasurementSet> & mss,
                               const Block<Int> & sortColumns,
                               Double timeInterval = 0);

virtual casa::vi::VisibilityIteratorImpl2::~VisibilityIteratorImpl2 ( ) [virtual]

// Copy construct.

This calls the assigment operator. VisibilityIteratorImpl2 (const VisibilityIteratorImpl2 & other, VisibilityIterator2 * rovi);

Destructor

Member Function Documentation

void casa::vi::VisibilityIteratorImpl2::addDataSelection ( const MeasurementSet & ms ) [protected]

virtual Bool casa::vi::VisibilityIteratorImpl2::allBeamOffsetsZero ( ) const [virtual]

True if all elements of the cube returned by getBeamOffsets are zero.

void casa::vi::VisibilityIteratorImpl2::allSpectralWindowsSelected	(	Vector< Int > &	spectralWindows,
		Vector< Int > &	nChannels
	)		const `[protected]`

const ChannelSelector* casa::vi::VisibilityIteratorImpl2::createDefaultChannelSelector	(	Double	time,
		Int	msId,
		Int	spectralWindowId
	)		`[protected]`

Slice casa::vi::VisibilityIteratorImpl2::findChannelsInRange	(	Double	lowerFrequency,
		Double	upperFrequency,
		const vi::SpectralWindowChannels &	spectralWindowChannels
	)		`[protected]`

Vector<Int> casa::vi::VisibilityIteratorImpl2::getChannels	(	Double	time,
		Int	frameOfReference
	)		const `[protected, virtual]`

void casa::vi::VisibilityIteratorImpl2::getColumnRows	(	const ROArrayColumn< T > &	column,
		Array< T > &	array
	)		const `[protected]`

void casa::vi::VisibilityIteratorImpl2::getColumnRows	(	const ROScalarColumn< T > &	column,
		Vector< T > &	array
	)		const `[protected]`

Vector<Double> casa::vi::VisibilityIteratorImpl2::getFrequencies	(	Double	time,
		Int	frameOfReference
	)		const `[protected, virtual]`

virtual const SpectralWindowChannels& casa::vi::VisibilityIteratorImpl2::getSpectralWindowChannels	(	Int	msId,
		Int	spectralWindowId
	)		const `[virtual]`

static BackWriter* casa::vi::VisibilityIteratorImpl2::makeBackWriter	(	void(VisibilityIteratorImpl2::*)(Ret)	setter,
		Ret(VisBuffer2::*)() const	getter
	)		`[inline, static, protected]`

static BackWriter* casa::vi::VisibilityIteratorImpl2::makeBackWriter2	(	void(VisibilityIteratorImpl2::*)(Ret, VisibilityIteratorImpl2::DataColumn)	setter,
		Ret(VisBuffer2::*)() const	getter,
		VisibilityIterator2::DataColumn	dc
	)		`[inline, static, protected]`

vi::ChannelSelector* casa::vi::VisibilityIteratorImpl2::makeChannelSelectorC	(	const FrequencySelection &	selection,
		Double	time,
		Int	msId,
		Int	spectralWindowId,
		Int	polarizationId
	)		`[protected]`

MFrequency::Convert casa::vi::VisibilityIteratorImpl2::makeFrequencyConverter	(	Double	time,
		Int	otherFrameOfReference,
		Bool	toObservedFrame
	)		const `[protected]`

void casa::vi::VisibilityIteratorImpl2::putColumnRows	(	ArrayColumn< T > &	column,
		const Array< T > &	array
	)		`[protected]`

void casa::vi::VisibilityIteratorImpl2::putColumnRows	(	ScalarColumn< T > &	column,
		const Vector< T > &	array
	)		`[protected]`

Bool casa::vi::VisibilityIteratorImpl2::usesTiledDataManager	(	const String &	columnName,
		const MeasurementSet &	ms
	)		const `[protected]`

virtual void casa::vi::VisibilityIteratorImpl2::writeModel	(	const RecordInterface &	rec,
		Bool	iscomponentlist = `True`,
		Bool	incremental = `False`
	)		`[virtual]`

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends