MirDataBuffer Class Reference

a buffer for data read in from a Miriad datatset More...

#include <MirDataBuffer.h>

Public Member Functions
	MirDataBuffer (...)
	create the container More...
Boolean	hasMore ()
	return true if there is still data to be read from the dataset More...
void	varUpdated (Boolean val)
	set the variable update state. More...
Boolean	isVarUpdated ()
	return the variable update state. More...
float *	operator[] (casacore::Int i)
	return a pointer to the i-th record in this buffer More...
double *	getPreamble (casacore::Int i)
	return the preamble for the i-th record More...
double	getTime ()
	return the current Miriad timestamp More...
casacore::Int	getBaselineNum (casacore::Int i)
	return the baseline number for the i-th record More...
double *	getBaselineVec (casacore::Int i)
	return the baseline vector as a 3-element array holding u, v, & w More...
casacore::Int	getPol (casacore::Int i)
	return the Miriad polarization code for the i-th record More...
casacore::Int	size ()
	return the number of records held in this buffer More...
void	reset ()
	update the number of records held by the buffer More...

Private Member Functions
	MirDataBuffer (MirDataBuffer &)

Private Attributes
Boolean	upd
Boolean	hasmore
casacore::Block< int >	pol
casacore::Block< double * >	preamble
casacore::Block< float * >	narrow
casacore::Block< float * >	wide
casacore::Int	nrec
casacore::Int	nnar
casacore::Int	nwide

Detailed Description

a buffer for data read in from a Miriad datatset

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

this class buffers data from a Miriad dataset

Motivation

MSes filled from Miriad data feature multiple windows of differing shapes. Performance during casacore::MS reads can be aided by collecting together casacore::MS table records of the same shape (e.g. of the same window). MirFiller accoplishes this by reading all baselines from a single timestamp at once, so that they written out in order of spectral window. This class provides a container for holding the data from different baselines.

Synopsis

At the moment, this is intended for use only by the MirFiller class.

Example

Definition at line 77 of file MirDataBuffer.h.

Constructor & Destructor Documentation

MirDataBuffer::MirDataBuffer ( MirDataBuffer &  )

private

MirDataBuffer::MirDataBuffer

(

...

)

create the container

Member Function Documentation

casacore::Int MirDataBuffer::getBaselineNum ( casacore::Int  i )

inline

return the baseline number for the i-th record

Definition at line 118 of file MirDataBuffer.h.

References preamble.

double* MirDataBuffer::getBaselineVec ( casacore::Int  i )

inline

return the baseline vector as a 3-element array holding u, v, & w

Definition at line 121 of file MirDataBuffer.h.

References preamble.

casacore::Int MirDataBuffer::getPol ( casacore::Int  i )

inline

return the Miriad polarization code for the i-th record

Definition at line 124 of file MirDataBuffer.h.

References pol.

double* MirDataBuffer::getPreamble ( casacore::Int  i )

inline

return the preamble for the i-th record

Definition at line 112 of file MirDataBuffer.h.

References preamble.

double MirDataBuffer::getTime ( )

inline

return the current Miriad timestamp

Definition at line 115 of file MirDataBuffer.h.

References preamble.

Boolean MirDataBuffer::hasMore ( )

inline

return true if there is still data to be read from the dataset

Definition at line 94 of file MirDataBuffer.h.

References hasmore.

Boolean MirDataBuffer::isVarUpdated ( )

inline

return the variable update state.

A value of true means that some variables have changed and should be checked for new values. false means that the variables have not changed since the last time they were checked.

Definition at line 106 of file MirDataBuffer.h.

References upd.

float* MirDataBuffer::operator[] ( casacore::Int  i )

inline

return a pointer to the i-th record in this buffer

Definition at line 109 of file MirDataBuffer.h.

void MirDataBuffer::reset ( void  )

inline

update the number of records held by the buffer

reset the buffer for a new time slot

switch cached record into first position

Definition at line 132 of file MirDataBuffer.h.

References hasmore, narrow, pol, preamble, and wide.

casacore::Int MirDataBuffer::size ( )

inline

return the number of records held in this buffer

Definition at line 127 of file MirDataBuffer.h.

References nrec.

void MirDataBuffer::varUpdated ( Boolean  val )

inline

set the variable update state.

A value of true means that some variables have changed and should be checked for new values. false means that the variables have not changed since the last time they were checked.

Definition at line 100 of file MirDataBuffer.h.

References upd.

Member Data Documentation

Boolean MirDataBuffer::hasmore

private

Definition at line 80 of file MirDataBuffer.h.

Referenced by hasMore(), and reset().

casacore::Block<float *> MirDataBuffer::narrow

private

Definition at line 84 of file MirDataBuffer.h.

Referenced by reset().

casacore::Int MirDataBuffer::nnar

private

Definition at line 86 of file MirDataBuffer.h.

casacore::Int MirDataBuffer::nrec

private

Definition at line 86 of file MirDataBuffer.h.

Referenced by size().

casacore::Int MirDataBuffer::nwide

private

Definition at line 86 of file MirDataBuffer.h.

casacore::Block<int> MirDataBuffer::pol

private

Definition at line 82 of file MirDataBuffer.h.

Referenced by getPol(), and reset().

casacore::Block<double *> MirDataBuffer::preamble

private

Definition at line 83 of file MirDataBuffer.h.

Referenced by getBaselineNum(), getBaselineVec(), getPreamble(), getTime(), and reset().

Boolean MirDataBuffer::upd

private

Definition at line 79 of file MirDataBuffer.h.

Referenced by isVarUpdated(), and varUpdated().

casacore::Block<float *> MirDataBuffer::wide

private

Definition at line 85 of file MirDataBuffer.h.

Referenced by reset().

---

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

• casa/code/miriad/Filling/MirDataBuffer.h