#include <VisIterator.h>

Inheritance diagram for casa::ROVisIterator:

Classes
class	Factory
Public Member Functions
	ROVisIterator ()
	Default constructor - useful only to assign another iterator later.
	ROVisIterator (const MeasurementSet &ms, const Block< Int > &sortColumns, Double timeInterval=0)
	Construct from MS and a Block of MS column enums specifying the iteration order, if none are specified, time iteration is implicit.
	ROVisIterator (const MeasurementSet &ms, const Block< Int > &sortColumns, Double timeInterval, const ROVisibilityIterator::Factory &factory)
	ROVisIterator (const ROVisIterator &other)
	Copy construct.
	~ROVisIterator ()
	Destructor.
ROVisIterator &	operator= (const ROVisIterator &other)
	Assignment.
ROVisIterator &	operator++ (int)
	Members.
ROVisIterator &	operator++ ()
Vector< Int > &	chanIds (Vector< Int > &chanids) const
	Return channel numbers in selected VisSet spectrum (i.e.
Vector< Int > &	chanIds (Vector< Int > &chanids, Int spw) const
Vector< Int > &	corrIds (Vector< Int > &corrids) const
	Return selected correlation indices.
Vector< Int > &	corrType (Vector< Int > &corrTypes) const
	Return the correlation type (returns Stokes enums)
void	selectChannel (const Vector< Vector< Slice > > &chansel)
	Set up new chan/corr selection via Vector<Slice>
void	selectCorrelation (const Vector< Vector< Slice > > &corrsel)
Vector< Matrix< Int > > &	setChanAveBounds (Float factor, Vector< Matrix< Int > > &bounds)
	Set up/return channel averaging bounds.
void	allSelectedSpectralWindows (Vector< Int > &spws, Vector< Int > &nvischan)
	Get selected spws and channel counts.
void	lsrFrequency (const Int &spw, Vector< Double > &freq, Bool &convert, const Bool ignoreconv=False)
	Convert the frequency from the observe frame to lsr frame.
void	getChannelSelection (Block< Vector< Int > > &, Block< Vector< Int > > &, Block< Vector< Int > > &, Block< Vector< Int > > &, Block< Vector< Int > > &)
	The following throws an exception, because this isn't the language of channel selection in VisIterator.
Int	numberChan (Int spw) const
	Return number of chans/corrs per spw/pol.
Int	numberCorr (Int pol) const
Protected Member Functions
void	getDataColumn (DataColumn whichOne, const Vector< Vector< Slice > > &slices, Cube< Complex > &data) const
virtual ROVisIteratorImpl *	getReadImpl () const

Detailed Description

Definition at line 116 of file VisIterator.h.

Constructor & Destructor Documentation

casa::ROVisIterator::ROVisIterator ( )

Default constructor - useful only to assign another iterator later.

casa::ROVisIterator::ROVisIterator	(	const MeasurementSet &	ms,
		const Block< Int > &	sortColumns,
		Double	timeInterval = `0`
	)

Construct from MS and a Block of MS column enums specifying the iteration order, if none are specified, time iteration is implicit.

An optional timeInterval 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 (in seconds) 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.

casa::ROVisIterator::ROVisIterator	(	const MeasurementSet &	ms,
		const Block< Int > &	sortColumns,
		Double	timeInterval,
		const ROVisibilityIterator::Factory &	factory
	)

casa::ROVisIterator::ROVisIterator ( const ROVisIterator & other )

Copy construct.

This calls the assignment operator.

casa::ROVisIterator::~ROVisIterator ( )

Destructor.

Member Function Documentation

void casa::ROVisIterator::allSelectedSpectralWindows	(	Vector< Int > &	spws,
		Vector< Int > &	nvischan
	)

Get selected spws and channel counts.

Reimplemented from casa::ROVisibilityIterator.

Vector<Int>& casa::ROVisIterator::chanIds ( Vector< Int > & chanids ) const

Return channel numbers in selected VisSet spectrum (i.e.

disregarding possible selection on the iterator, but including the selection set when creating the VisSet)

Vector<Int>& casa::ROVisIterator::chanIds	(	Vector< Int > &	chanids,
		Int	spw
	)		const

Vector<Int>& casa::ROVisIterator::corrIds ( Vector< Int > & corrids ) const

Return selected correlation indices.

Vector<Int>& casa::ROVisIterator::corrType ( Vector< Int > & corrTypes ) const [virtual]

Return the correlation type (returns Stokes enums)

Reimplemented from casa::ROVisibilityIterator.

void casa::ROVisIterator::getChannelSelection	(	Block< Vector< Int > > &	,
		Block< Vector< Int > > &	,
		Block< Vector< Int > > &	,
		Block< Vector< Int > > &	,
		Block< Vector< Int > > &
	)		`[inline]`

The following throws an exception, because this isn't the language of channel selection in VisIterator.

Reimplemented from casa::ROVisibilityIterator.

Definition at line 181 of file VisIterator.h.

void casa::ROVisIterator::getDataColumn	(	DataColumn	whichOne,
		const Vector< Vector< Slice > > &	slices,
		Cube< Complex > &	data
	)		const `[protected]`

virtual ROVisIteratorImpl* casa::ROVisIterator::getReadImpl ( ) const [protected, virtual]

Reimplemented from casa::ROVisibilityIterator.

void casa::ROVisIterator::lsrFrequency	(	const Int &	spw,
		Vector< Double > &	freq,
		Bool &	convert,
		const Bool	ignoreconv = `False`
	)

Convert the frequency from the observe frame to lsr frame.

Returns True in convert if given spw was not observed in the LSRK frame when ignoreconv=True...no conversion is done from data frame frequency is served as is

Reimplemented from casa::ROVisibilityIterator.

Int casa::ROVisIterator::numberChan ( Int spw ) const

Return number of chans/corrs per spw/pol.

Int casa::ROVisIterator::numberCorr ( Int pol ) const

ROVisIterator& casa::ROVisIterator::operator++ ( int )

Members.

Advance iterator through data

Reimplemented from casa::ROVisibilityIterator.

Reimplemented in casa::VisIterator.

ROVisIterator& casa::ROVisIterator::operator++ ( )

Reimplemented from casa::ROVisibilityIterator.

Reimplemented in casa::VisIterator.

ROVisIterator& casa::ROVisIterator::operator= ( const ROVisIterator & other )

Assignment.

Any attached VisBuffers are lost in the assign.

void casa::ROVisIterator::selectChannel ( const Vector< Vector< Slice > > & chansel )

Set up new chan/corr selection via Vector<Slice>

void casa::ROVisIterator::selectCorrelation ( const Vector< Vector< Slice > > & corrsel )

Vector<Matrix<Int> >& casa::ROVisIterator::setChanAveBounds	(	Float	factor,
		Vector< Matrix< Int > > &	bounds
	)

Set up/return channel averaging bounds.

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

code/synthesis/MSVis/VisIterator.h

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation