MirDataRecord Class Reference

a container for a data record read in from a Miriad datatset More...

#include <MirVisReader.h>

Inheritance diagram for MirDataRecord:

Public Member Functions
	MirDataRecord (casacore::Int nnarrow=0, casacore::Int nwide=0, casacore::Int npreamble=5)
	~MirDataRecord ()
casacore::uInt	getPreambleCount ()
	return the number of preamble elements More...
casacore::uInt	getNarrowCount ()
	return the number of narrow band channels More...
casacore::uInt	getWideCount ()
	return the number of wide band channels More...
casacore::Double *	preamble ()
	return the address of the preamble buffer More...
casacore::Float *	narrow ()
	return the address of the narrow channel data buffer More...
casacore::Float *	wide ()
	return the address of the wide channel data buffer More...
casacore::Int *	flags ()
	return the address of the flags channel data buffer More...
casacore::Int *	wflags ()
	return the address of the wflags channel data buffer More...
casacore::Int	pol ()
	return the polarization code More...
void	setPol (casacore::Int val)
	set the polarization code More...
casacore::Bool	isMarked ()
	return true if this record is marked More...
void	setMarked (casacore::Bool val)
	set the mark More...
void	copyFrom (const MirDataRecord &other)

Private Attributes
casacore::Int	np_p
casacore::Int	nn_p
casacore::Int	nw_p
casacore::Int	pol_p
casacore::Bool	marked_p
casacore::Double *	preamble_p
casacore::Float *	narrow_p
casacore::Float *	wide_p
casacore::Int *	flags_p
casacore::Int *	wflags_p

Additional Inherited Members
Private Member Functions inherited from MirTypeAssert
	MirTypeAssert ()
Static Private Attributes inherited from MirTypeAssert
static casacore::Bool	ok

Detailed Description

a container for a data record read in from a Miriad datatset

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

this class holds the record-dependent 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.

Access Performance is aided when the data from a Miriad dataset is filled in a particular order. This class provides a container so that the data can be buffered for "sorting" prior to filling into the output MS.

Synopsis

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

Example

Definition at line 95 of file MirVisReader.h.

Constructor & Destructor Documentation

MirDataRecord::MirDataRecord	(	casacore::Int	nnarrow = 0,
		casacore::Int	nwide = 0,
		casacore::Int	npreamble = 5
	)

MirDataRecord::~MirDataRecord

(

)

Member Function Documentation

void MirDataRecord::copyFrom

(

const MirDataRecord &

other

)

casacore::Int* MirDataRecord::flags ( )

inline

return the address of the flags channel data buffer

Definition at line 127 of file MirVisReader.h.

References flags_p.

casacore::uInt MirDataRecord::getNarrowCount ( )

inline

return the number of narrow band channels

Definition at line 112 of file MirVisReader.h.

References nn_p.

casacore::uInt MirDataRecord::getPreambleCount ( )

inline

return the number of preamble elements

Definition at line 109 of file MirVisReader.h.

References np_p.

casacore::uInt MirDataRecord::getWideCount ( )

inline

return the number of wide band channels

Definition at line 115 of file MirVisReader.h.

References nw_p.

casacore::Bool MirDataRecord::isMarked ( )

inline

return true if this record is marked

Definition at line 139 of file MirVisReader.h.

References marked_p.

casacore::Float* MirDataRecord::narrow ( )

inline

return the address of the narrow channel data buffer

Definition at line 121 of file MirVisReader.h.

References narrow_p.

casacore::Int MirDataRecord::pol ( )

inline

return the polarization code

Definition at line 133 of file MirVisReader.h.

References pol_p.

casacore::Double* MirDataRecord::preamble ( )

inline

return the address of the preamble buffer

Definition at line 118 of file MirVisReader.h.

References preamble_p.

void MirDataRecord::setMarked ( casacore::Bool  val )

inline

set the mark

Definition at line 142 of file MirVisReader.h.

References marked_p.

void MirDataRecord::setPol ( casacore::Int  val )

inline

set the polarization code

Definition at line 136 of file MirVisReader.h.

References pol_p.

casacore::Int* MirDataRecord::wflags ( )

inline

return the address of the wflags channel data buffer

Definition at line 130 of file MirVisReader.h.

References wflags_p.

casacore::Float* MirDataRecord::wide ( )

inline

return the address of the wide channel data buffer

Definition at line 124 of file MirVisReader.h.

References wide_p.

Member Data Documentation

casacore::Int* MirDataRecord::flags_p

private

Definition at line 101 of file MirVisReader.h.

Referenced by flags().

casacore::Bool MirDataRecord::marked_p

private

Definition at line 97 of file MirVisReader.h.

Referenced by isMarked(), and setMarked().

casacore::Float* MirDataRecord::narrow_p

private

Definition at line 99 of file MirVisReader.h.

Referenced by narrow().

casacore::Int MirDataRecord::nn_p

private

Definition at line 96 of file MirVisReader.h.

Referenced by getNarrowCount().

casacore::Int MirDataRecord::np_p

private

Definition at line 96 of file MirVisReader.h.

Referenced by getPreambleCount().

casacore::Int MirDataRecord::nw_p

private

Definition at line 96 of file MirVisReader.h.

Referenced by getWideCount().

casacore::Int MirDataRecord::pol_p

private

Definition at line 96 of file MirVisReader.h.

Referenced by pol(), and setPol().

casacore::Double* MirDataRecord::preamble_p

private

Definition at line 98 of file MirVisReader.h.

Referenced by preamble().

casacore::Int* MirDataRecord::wflags_p

private

Definition at line 102 of file MirVisReader.h.

Referenced by wflags().

casacore::Float* MirDataRecord::wide_p

private

Definition at line 100 of file MirVisReader.h.

Referenced by wide().

---

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

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