VisBufferImpls encapsulate one chunk of visibility data for processing. More...

#include <VisBufferImpl2.h>

Inheritance diagram for casa::vi::VisBufferImpl2:

Public Member Functions
	VisBufferImpl2 ()
	Create empty VisBufferImpl2 you can assign to or attach.
	VisBufferImpl2 (VisibilityIterator2 *iter, VisBufferOptions options)
	Construct VisBufferImpl2 for a particular VisibilityIterator2 The buffer will remain synchronized with the iterator.
virtual	~VisBufferImpl2 ()
	Destructor (detaches from VisIter)
virtual void	associateWithVisibilityIterator2 (const VisibilityIterator2 &vi)
virtual void	copy (const VisBuffer2 &other, Bool fetchIfNeeded=True)
	Copies all of the components (or just the one in the cache) from the specified VisBuffer into this one.
virtual void	copyComponents (const VisBuffer2 &other, const VisBufferComponents2 &components, Bool fetchIfNeeded=True)
	Copies the specified components (or just the one in the cache) from the specified VisBuffer into this one.
virtual void	copyCoordinateInfo (const VisBuffer2 *vb, Bool dirDependent, Bool fetchIfNeeded=True)
	Copies the coordinate components from the specified VisBuffer into this one.
virtual Vector< Int >	getCorrelationNumbers () const

virtual String	getFillErrorMessage () const
virtual Double	getFrequency (Int rowInBuffer, Int frequencyIndex, Int frame=FrameNotSpecified) const
virtual const Vector< Double > &	getFrequencies (Int rowInBuffer, Int frame=FrameNotSpecified) const
virtual Int	getChannelNumber (Int rowInBuffer, Int frequencyIndex) const
virtual const Vector< Int > &	getChannelNumbers (Int rowInBuffer) const
virtual const VisibilityIterator2 *	getVi () const
	For attached VBs this returns the VI the VB is attached to.
virtual void	invalidate ()
virtual Bool	isAttached () const
virtual Bool	isFillable () const
virtual void	setShape (Int nCorrelations, Int nChannels, Int nRows, Bool clearTheCache=True)
virtual void	validateShapes () const
virtual void	writeChangesBack ()

virtual const Vector< Float > &	feedPa (Double time) const
	--> This needs to be removed: virtual Bool fetch(const asyncio::PrefetchColumns *pfc);
virtual Float	parang0 (Double time) const
	NOMINAL parallactic angle (feed p.a.
virtual const Vector< Float > &	parang (Double time) const
	Calculates the parallactic angle of each antenna in the array at the specified time.
virtual MDirection	azel0 (Double time) const
	virtual void setVisCubeModel(const Vector<Float>& stokes) = 0; // [1..4] virtual const Matrix<CStokesVector> & visModel () const = 0; // [nF,nR] virtual void setVisModel (Matrix<CStokesVector> &) = 0; // [nF,nR]
virtual const Vector < MDirection > &	azel (Double time) const
	Returns the pointing angle for each antenna in the array at the specified time.
virtual Double	hourang (Double time) const
	Hour angle for specified time.
virtual void	sortCorr ()
	Sort/unsort the correlations, if necessary (Rudimentary handling of non-canonically sorted correlations--use with care!)
virtual void	unSortCorr ()
virtual void	normalize ()
	Normalize the visCube by the modelVisCube (and optionally also divide visCube_p by its normalized amp)
virtual void	resetWeightsUsingSigma ()
	Fill weightMat according to sigma column.
virtual Bool	isNewArrayId () const
	Rotate visibility phase for given vector (dim = nrow of vb) of phases (metres)
virtual Bool	isNewFieldId () const
virtual Bool	isNewMs () const
virtual Bool	isNewSpectralWindow () const
virtual Bool	isRekeyable () const
virtual Bool	isWritable () const
virtual Int	msId () const
virtual String	msName (Bool stripPath=False) const
virtual Subchunk	getSubchunk () const
virtual Bool	areCorrelationsSorted () const
virtual IPosition	getValidShape (Int) const
virtual VisModelData	getVisModelData () const
Data accessors and	setters (where appropriate) There are the methods that allows access to the items cached in the VisBuffer.The straight accessors provide read-only access to the item.Where the item is allowed to be modified
Data accessors and one or more set methods are provided N weight vs weightMat will not modify the cached value in a different representation *virtual const Vector< Int > &	antenna1 () const
virtual void	setAntenna1 (const Vector< Int > &value)
virtual const Vector< Int > &	antenna2 () const
virtual void	setAntenna2 (const Vector< Int > &value)
virtual const Vector< Int > &	arrayId () const
virtual void	setArrayId (const Vector< Int > &)
virtual const Vector < SquareMatrix< Complex, 2 > > &	cjones () const
	Returns the Jones C matrix for each antenna.
virtual const Vector< Int > &	correlationTypes () const
	Returns the correlation type of each correlation in the VisCube.
virtual const Vector< Int > &	dataDescriptionIds () const
	virtual Int dataDescriptionId () const; virtual void setDataDescriptionId (Int value);
virtual void	setDataDescriptionIds (const Vector< Int > &)
virtual const Vector < MDirection > &	direction1 () const
virtual const Vector < MDirection > &	direction2 () const
virtual const Vector< Double > &	exposure () const
virtual void	setExposure (const Vector< Double > &value)
virtual const Vector< Int > &	feed1 () const
virtual void	setFeed1 (const Vector< Int > &value)
virtual const Vector< Float > &	feedPa1 () const
	Calculates the parallactic angle for feed 0 of the row's Antenna1.
virtual const Vector< Int > &	feed2 () const
virtual void	setFeed2 (const Vector< Int > &value)
virtual const Vector< Float > &	feedPa2 () const
	Calculates the parallactic angle for feed 0 of the row's Antenna2.
virtual const Vector< Int > &	fieldId () const
virtual void	setFieldId (const Vector< Int > &)
virtual const Matrix< Bool > &	flag () const
virtual void	setFlag (const Matrix< Bool > &)
virtual const Array< Bool > &	flagCategory () const
virtual void	setFlagCategory (const Array< Bool > &)
virtual const Cube< Bool > &	flagCube () const
virtual void	setFlagCube (const Cube< Bool > &)
virtual const Vector< Bool > &	flagRow () const
virtual void	setFlagRow (const Vector< Bool > &)
virtual const Matrix< Float > &	imagingWeight () const
	This method returns the imaging weights associated with the VisBuffer.
virtual Int	nAntennas () const
virtual Int	nChannels () const
virtual Int	nCorrelations () const
	Returns the number of correlations along the visCube correlation axis.
virtual Int	nRows () const
	Returns the number of rows in this VisBuffer.
virtual const Vector< Int > &	observationId () const
virtual void	setObservationId (const Vector< Int > &value)
virtual const MDirection &	phaseCenter () const
	Returns the phase center of the array for the specified row.
virtual Int	polarizationFrame () const
	Returns the polarization frame for the specified row.
virtual Int	polarizationId () const
virtual const Vector< Int > &	processorId () const
virtual void	setProcessorId (const Vector< Int > &value)
virtual const Vector< uInt > &	rowIds () const
	The returned Vector serves as a map between the rows in the VisBuffer and the row IDs in the underlying MS main virtual table: mainTableID [i] = rowIds () [ i] = 0;.
virtual const Vector< Int > &	scan () const
virtual void	setScan (const Vector< Int > &value)
virtual const Matrix< Float > &	sigma () const
virtual void	setSigma (const Matrix< Float > &)
virtual const Vector< Int > &	spectralWindows () const
	virtual const Matrix<Float> & sigmaMat () const; virtual Int spectralWindow () const;
virtual const Vector< Int > &	stateId () const
	virtual void setSpectralWindows (const Vector<Int> & spectralWindows);
virtual void	setStateId (const Vector< Int > &value)
virtual const Vector< Double > &	time () const
virtual void	setTime (const Vector< Double > &value)
virtual const Vector< Double > &	timeCentroid () const
virtual void	setTimeCentroid (const Vector< Double > &value)
virtual const Vector< Double > &	timeInterval () const
virtual void	setTimeInterval (const Vector< Double > &value)
virtual const Matrix< Double > &	uvw () const
virtual void	setUvw (const Matrix< Double > &value)
virtual const Cube< Complex > &	visCubeCorrected () const
	virtual const Matrix<CStokesVector> & vis () const = 0; // [nF,nR] virtual void setVis (Matrix<CStokesVector> &) = 0; // [nF,nR]
virtual void	setVisCubeCorrected (const Cube< Complex > &)
virtual const Cube< Float > &	visCubeFloat () const
	virtual const Matrix<CStokesVector> & visCorrected () const; virtual void setVisCorrected (const Matrix<CStokesVector> &);
virtual void	setVisCubeFloat (const Cube< Float > &)
virtual const Cube< Complex > &	visCubeModel () const
virtual void	setVisCubeModel (const Complex &c)
virtual void	setVisCubeModel (const Cube< Complex > &vis)
virtual const Cube< Complex > &	visCube () const
	virtual void setVisCubeModel(const Vector<Float>& stokes); virtual const Matrix<CStokesVector> & visModel () const; virtual void setVisModel (Matrix<CStokesVector> &);
virtual void	setVisCube (const Complex &c)
virtual void	setVisCube (const Cube< Complex > &)
virtual const Matrix< Float > &	weight () const
	virtual const Matrix<CStokesVector> & vis () const; virtual void setVis (Matrix<CStokesVector> &);
virtual void	setWeight (const Matrix< Float > &)
virtual const Cube< Float > &	weightSpectrum () const
	virtual const Matrix<Float> & weightMat () const; virtual void setWeightMat (const Matrix<Float>&);
virtual void	setWeightSpectrum (const Cube< Float > &)
Public Attributes
Data accessors and one or more set methods are provided N	B: the VB usually caches the information in the representation requested so that using a setter to modify a value (e.g.
Protected Member Functions
void	adjustWeightFactorsAndFlags (Matrix< Float > &rowWeightFactors, Bool useWeightSpectrum, Int nRows, Int nCorrelations, Int nChannelsOut)
	Attach to a VisIter.
void	adjustWeightAndSigmaMatrices (Int nChannelsAveraged, Int nChannelsOut, Int nRows, Int nCorrelations, Int nChannelsSelected, const Matrix< Float > &rowWeightFactors)
Int	averageChannelFrequencies (Int nChannelsOut, const Vector< Int > &channels, const Matrix< Int > &averagingBounds)
void	averageFlagInfoChannels (const Matrix< Int > &averagingBounds, Int nChannelsOut, Bool useWeightSpectrum)
template<typename T >
void	averageVisCubeChannels (T &dataCache, Int nChanOut, const Matrix< Int > &averagingbounds)
virtual void	cacheClear (Bool markAsCached=False)
virtual void	cacheResizeAndZero (const VisBufferComponents2 &exclusions=VisBufferComponents2())
virtual void	checkVisIter (const char func, const char file, int line, const char *extra="") const
void	computeRowWeightFactors (Matrix< Float > &rowWeightFactors, Bool useWeightSpectrum)
virtual void	configureNewSubchunk (Int msId, const String &msName, Bool isNewMs, Bool isNewArrayId, Bool isNewFieldId, Bool isNewSpectralWindow, const Subchunk &subchunk, Int nRows, Int nChannels, Int nCorrelations, const Vector< Int > &correlations)
virtual void	copyRow (Int sourceRow, Int destinationRow)
virtual void	deleteRows (const Vector< Int > &rowsToDelete)
virtual void	dirtyComponentsAdd (const VisBufferComponents2 &additionalDirtyComponents)
virtual void	dirtyComponentsAdd (VisBufferComponent2 component)
virtual void	dirtyComponentsClear ()
virtual VisBufferComponents2	dirtyComponentsGet () const
virtual void	dirtyComponentsSet (const VisBufferComponents2 &dirtyComponents)
virtual void	dirtyComponentsSet (VisBufferComponent2 component)
void	normalizeRow (Int row, Int nCorrelations, const Matrix< Bool > &flagged, Cube< Complex > &visCube, Cube< Complex > &modelCube, Matrix< Float > &weightMat)
virtual void	sortCorrelationsAux (Bool makeSorted)
virtual VisibilityIterator2 *	getViP () const
void	registerCacheItem (VbCacheItemBase *)
virtual void	resizeRows (Int newNRows)
virtual void	stateCopy (const VisBufferImpl2 &other)
virtual void	setFillable (Bool isFillable)
virtual void	setRekeyable (Bool isRekeyable)
virtual void	setupValidShapes ()
template<typename Coord >
void	updateCoord (Coord &item, const Coord &otherItem)
virtual Vector< Bool > &	flagRowRef ()
virtual Cube< Bool > &	flagCubeRef ()
virtual Cube< Complex > &	visCubeRef ()
virtual Cube< Complex > &	visCubeCorrectedRef ()
virtual Cube< Complex > &	visCubeModelRef ()
virtual Cube< Float > &	weightSpectrumRef ()
Private Member Functions
virtual Bool	areCorrelationsInCanonicalOrder () const
void	checkVisIterBase (const char func, const char file, int line, const char *extra="") const
void	construct (VisibilityIterator2 *vi, VisBufferOptions options)
void	constructCache ()
void	setIterationInfo (Int msId, const String &msName, Bool isNewMs, Bool isNewArrayId, Bool isNewFieldId, Bool isNewSpectralWindow, const Subchunk &subchunk, const Vector< Int > &correlations)
virtual void	validate ()
Fillers These methods fill the needed value into the cache This usually means getting it from the attached VisibilityIterator2 but the needed value can be generated as well The name of the filler should match up with the accessor	method (see above) as well as the member name in the cache(see VisBufferCache class in VisBuffer.cc).*/virtual void fillAntenna1(Vector< Int > &value) const
virtual void	fillAntenna2 (Vector< Int > &value) const
virtual void	fillArrayId (Vector< Int > &value) const
virtual void	fillCorrType (Vector< Int > &value) const
virtual void	fillCubeCorrected (Cube< Complex > &value) const
virtual void	fillCubeModel (Cube< Complex > &value) const
virtual void	fillCubeObserved (Cube< Complex > &value) const
virtual void	fillDataDescriptionId (Int &value) const
virtual void	fillDataDescriptionIds (Vector< Int > &value) const
virtual void	fillDirection1 (Vector< MDirection > &value) const
virtual void	fillDirection2 (Vector< MDirection > &value) const
virtual void	fillDirectionAux (Vector< MDirection > &value, const Vector< Int > &antenna, const Vector< Int > &feed, const Vector< Float > &feedPa) const
virtual void	fillExposure (Vector< Double > &value) const
virtual void	fillFeed1 (Vector< Int > &value) const
virtual void	fillFeed2 (Vector< Int > &value) const
virtual void	fillFeedPa1 (Vector< Float > &feedPa) const
virtual void	fillFeedPa2 (Vector< Float > &feedPa) const
virtual void	fillFeedPaAux (Vector< Float > &feedPa, const Vector< Int > &antenna, const Vector< Int > &feed) const
virtual void	fillFieldId (Vector< Int > &value) const
virtual void	fillFlag (Matrix< Bool > &value) const
virtual void	fillFlagCategory (Array< Bool > &value) const
virtual void	fillFlagCube (Cube< Bool > &value) const
virtual void	fillFlagRow (Vector< Bool > &value) const
virtual void	fillFloatData (Cube< Float > &value) const
virtual void	fillImagingWeight (Matrix< Float > &value) const
virtual void	fillJonesC (Vector< SquareMatrix< Complex, 2 > > &value) const
virtual void	fillNAntennas (Int &value) const
virtual void	fillNChannel (Int &value) const
virtual void	fillNCorr (Int &value) const
virtual void	fillNRow (Int &value) const
virtual void	fillObservationId (Vector< Int > &value) const
virtual void	fillPhaseCenter (MDirection &value) const
virtual void	fillPolFrame (Int &value) const
virtual void	fillPolarizationId (Int &value) const
virtual void	fillProcessorId (Vector< Int > &value) const
virtual void	fillRowIds (Vector< uInt > &value) const
virtual void	fillScan (Vector< Int > &value) const
virtual void	fillSigma (Matrix< Float > &value) const
virtual void	fillSpectralWindows (Vector< Int > &value) const
	virtual void fillSigmaMat (Matrix<Float>& value) const; virtual void fillSpectralWindow (Int& value) const;
virtual void	fillStateId (Vector< Int > &value) const
virtual void	fillTime (Vector< Double > &value) const
virtual void	fillTimeCentroid (Vector< Double > &value) const
virtual void	fillTimeInterval (Vector< Double > &value) const
virtual void	fillUvw (Matrix< Double > &value) const
virtual void	fillWeight (Matrix< Float > &value) const
	virtual void fillVisibilityCorrected (Matrix<CStokesVector>& value) const; virtual void fillVisibilityModel (Matrix<CStokesVector>& value) const; virtual void fillVisibilityObserved (Matrix<CStokesVector>& value) const;
virtual void	fillWeightSpectrum (Cube< Float > &value) const
	virtual void fillWeightMat (Matrix<Float>& value) const;
Private Attributes
VisBufferCache *	cache_p
VisBufferState *	state_p
Friends
class	VLAT
class	VbCacheItemBase
class	VisBufferCache
class	VisBufferState
class	VisBuffer2
class	VisBufferImpl2Async
class	VisBufferImpl2AsyncWrapper
class	ViReadImpl
class	ViReadImplAsync

Detailed Description

VisBufferImpls encapsulate one chunk of visibility data for processing.

Intended use:

Public interface

Prerequisite

Etymology

VisBufferImpl is a buffer for visibility data

Synopsis

This class contains 'one iteration' of the VisibilityIterator2 It is a modifiable buffer of values to which calibration and averaging can be applied. This allows processing of the data in larger blocks, avoiding some overheads for processing per visibility point or spectrum.

See MeasurementEquations for more details on how the VisBufferImpl is to be used.

When the user intends to allow asynchronous I/O they will need to use the VisBufferImplAsync and VisBufferImplAsyncWrapper classes; these are publicly derived from VisBufferImpl. Normally, the user should not explicitly use these classes but should use the helper class VisBufferImplAutoPtr which will ensure that the appropriate class is used.

Definition at line 107 of file VisBufferImpl2.h.

Constructor & Destructor Documentation

casa::vi::VisBufferImpl2::VisBufferImpl2 ( )

Create empty VisBufferImpl2 you can assign to or attach.

casa::vi::VisBufferImpl2::VisBufferImpl2	(	VisibilityIterator2 *	iter,
		VisBufferOptions	options
	)

Construct VisBufferImpl2 for a particular VisibilityIterator2 The buffer will remain synchronized with the iterator.

Copy construct, looses synchronization with iterator: only use buffer for current iteration (or reattach).

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

Destructor (detaches from VisIter)

Member Function Documentation

void casa::vi::VisBufferImpl2::adjustWeightAndSigmaMatrices	(	Int	nChannelsAveraged,
		Int	nChannelsOut,
		Int	nRows,
		Int	nCorrelations,
		Int	nChannelsSelected,
		const Matrix< Float > &	rowWeightFactors
	)		`[protected]`

void casa::vi::VisBufferImpl2::adjustWeightFactorsAndFlags	(	Matrix< Float > &	rowWeightFactors,
		Bool	useWeightSpectrum,
		Int	nRows,
		Int	nCorrelations,
		Int	nChannelsOut
	)		`[protected]`

Attach to a VisIter.

Detaches itself first if already attached to a VisIter. Will remain synchronized with iterator.

virtual void cacheCopy (const VisBufferImpl2 & other, Bool markAsCached);

Data accessors and one or more set methods are provided N weight vs weightMat will not modify the cached value in a different representation* virtual const Vector<Int>& casa::vi::VisBufferImpl2::antenna1 ( ) const [virtual]

virtual const Vector<Int>& casa::vi::VisBufferImpl2::antenna2 ( ) const [virtual]

Int casa::vi::VisBufferImpl2::averageChannelFrequencies	(	Int	nChannelsOut,
		const Vector< Int > &	channels,
		const Matrix< Int > &	averagingBounds
	)		`[protected]`

void casa::vi::VisBufferImpl2::averageFlagInfoChannels	(	const Matrix< Int > &	averagingBounds,
		Int	nChannelsOut,
		Bool	useWeightSpectrum
	)		`[protected]`

void casa::vi::VisBufferImpl2::averageVisCubeChannels	(	T &	dataCache,
		Int	nChanOut,
		const Matrix< Int > &	averagingbounds
	)		`[protected]`

virtual void casa::vi::VisBufferImpl2::checkVisIter	(	const char *	func,
		const char *	file,
		int	line,
		const char *	extra = `""`
	)		const `[protected, virtual]`

void casa::vi::VisBufferImpl2::checkVisIterBase	(	const char *	func,
		const char *	file,
		int	line,
		const char *	extra = `""`
	)		const `[private]`

void casa::vi::VisBufferImpl2::computeRowWeightFactors	(	Matrix< Float > &	rowWeightFactors,
		Bool	useWeightSpectrum
	)		`[protected]`

virtual void casa::vi::VisBufferImpl2::configureNewSubchunk	(	Int	msId,
		const String &	msName,
		Bool	isNewMs,
		Bool	isNewArrayId,
		Bool	isNewFieldId,
		Bool	isNewSpectralWindow,
		const Subchunk &	subchunk,
		Int	nRows,
		Int	nChannels,
		Int	nCorrelations,
		const Vector< Int > &	correlations
	)		`[protected, virtual]`

void casa::vi::VisBufferImpl2::construct	(	VisibilityIterator2 *	vi,
		VisBufferOptions	options
	)		`[private]`

virtual void casa::vi::VisBufferImpl2::copy	(	const VisBuffer2 &	other,
		Bool	fetchIfNeeded = `True`
	)		`[virtual]`

virtual void casa::vi::VisBufferImpl2::copyCoordinateInfo	(	const VisBuffer2 *	other,
		Bool	includeDirections,
		Bool	fetchIfNeeded = `True`
	)		`[virtual]`

virtual void casa::vi::VisBufferImpl2::copyRow	(	Int	sourceRow,
		Int	destinationRow
	)		`[protected, virtual]`

virtual void casa::vi::VisBufferImpl2::fillDirectionAux	(	Vector< MDirection > &	value,
		const Vector< Int > &	antenna,
		const Vector< Int > &	feed,
		const Vector< Float > &	feedPa
	)		const `[private, virtual]`

virtual void casa::vi::VisBufferImpl2::fillFeedPaAux	(	Vector< Float > &	feedPa,
		const Vector< Int > &	antenna,
		const Vector< Int > &	feed
	)		const `[private, virtual]`

virtual Int casa::vi::VisBufferImpl2::getChannelNumber	(	Int	rowInBuffer,
		Int	frequencyIndex
	)		const `[virtual]`

virtual const Vector<Double>& casa::vi::VisBufferImpl2::getFrequencies	(	Int	rowInBuffer,
		Int	frame = `FrameNotSpecified`
	)		const `[virtual]`

virtual Double casa::vi::VisBufferImpl2::getFrequency	(	Int	rowInBuffer,
		Int	frequencyIndex,
		Int	frame = `FrameNotSpecified`
	)		const `[virtual]`

void casa::vi::VisBufferImpl2::normalizeRow	(	Int	row,
		Int	nCorrelations,
		const Matrix< Bool > &	flagged,
		Cube< Complex > &	visCube,
		Cube< Complex > &	modelCube,
		Matrix< Float > &	weightMat
	)		`[protected]`

void casa::vi::VisBufferImpl2::setIterationInfo	(	Int	msId,
		const String &	msName,
		Bool	isNewMs,
		Bool	isNewArrayId,
		Bool	isNewFieldId,
		Bool	isNewSpectralWindow,
		const Subchunk &	subchunk,
		const Vector< Int > &	correlations
	)		`[private]`

virtual void casa::vi::VisBufferImpl2::setShape	(	Int	nCorrelations,
		Int	nChannels,
		Int	nRows,
		Bool	clearTheCache = `True`
	)		`[virtual]`

void casa::vi::VisBufferImpl2::updateCoord	(	Coord &	item,
		const Coord &	otherItem
	)		`[protected]`

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends