Provides and lists information about the header of an image. More...

#include <MSSummary.h>

Public Member Functions
	MSSummary (const MeasurementSet &)
	Constructor.
	MSSummary (const MeasurementSet *)
	MSSummary (const MeasurementSet *ms, const String msname)
	~MSSummary ()
	Destructor.
Int	nrow () const
	Retrieve number of rows.
String	name () const
	Retrieve image name.
Bool	setMS (const MeasurementSet &ms)
	Set a new MS.
void	list (LogIO &os, Bool verbose=False) const
	List all header information.
void	list (LogIO &os, Record &outRec, Bool verbose=False, Bool fillRecord=True) const
	Return some useful info in a record too along with os.
void	listTitle (LogIO &os) const
	List a title for the Summary.
void	listWhere (LogIO &os, Bool verbose=False) const
	List convenient groupings of tables: list where MS obtained (Observation and Array tables)
void	listWhat (LogIO &os, Bool verbose=False) const
	List what was observed (Field and Main tables)
void	listWhat (LogIO &os, Record &outRec, Bool verbose=False, Bool fillRecord=True) const
void	listHow (LogIO &os, Bool verbose=False) const
	List how data were obtained (SpectralWindow, Feed, and Antenna tables)
void	listMain (LogIO &os, Bool verbose=False) const
	List main table.
void	listMain (LogIO &os, Record &outRec, Bool verbose=False, Bool fillRecord=True) const
	Return some useful info in a record too along with os.
void	getScanSummary (Record &outRec) const
	Return a Record with information derived from the main table.
void	listAntenna (LogIO &os, Bool verbose=False) const
	List subtables.
void	listFeed (LogIO &os, Bool verbose=False) const
void	listField (LogIO &os, Bool verbose=False) const
void	listField (LogIO &os, Record &outRec, Bool verbose=False, Bool fillRecord=True) const
void	listObservation (LogIO &os, Bool verbose=False) const
void	listHistory (LogIO &os) const
void	listPolarization (LogIO &os, Bool verbose=False) const
void	listSource (LogIO &os, Bool verbose=False) const
void	listSpectralWindow (LogIO &os, Bool verbose=False) const
void	getSpectralWindowInfo (Record &outRec) const
void	listSpectralAndPolInfo (LogIO &os, Bool verbose=False) const
void	listSysCal (LogIO &os, Bool verbose=False) const
void	listWeather (LogIO &os, Bool verbose=False) const
void	listTables (LogIO &os, Bool verbose=False) const
	List table size summary.
void	setListUnflaggedRowCount (Bool v)
void	setMetaDataCacheSizeInMB (Float cacheSize)
	set the cache size, in MB, for the MSMetaData object.
Private Member Functions
void	clearFlags (LogIO &os) const
	Clear formatting flags.
Private Attributes
const MeasurementSet *	pMS
	Pointer to MS.
std::auto_ptr< MSMetaData >	_msmd
const String	dashlin1
	Formatting strings.
const String	dashlin2
Vector< Int >	nVisPerField_
	For keeping track of the number of vis per field.
String	msname_p
	Name of the MS used in the constructor.
Bool	_listUnflaggedRowCount
Float	_cacheSizeMB

Detailed Description

Provides and lists information about the header of an image.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

MeasurementSet
Coordinates

Etymology

This class lists the ancilliary or header information from a MeasurementSet in a Summary format.

Synopsis

MSs consist of pixels and descriptive information stored in what is loosely termed the header. This is information describing the coordinate system, the image units etc. This class enables you to retrieve the descriptive header information and/or list it.

Example

        PagedMS<Float> inMS(fileName);
        MSSummary<Float> header(inMS);
        LogOrigin or("myClass", "myFunction(...)", WHERE);
        LogIO os(or);
        header.list(os);

A PagedMS object is constructed and then logged to the supplied LogIO object.

Caution: Note that if the PagedMS goes out of scope, this class will retrieve rubbish as it just maintains a pointer to the image;

Motivation

The viewing of the image header is a basic capability that is commonly required.

Definition at line 92 of file MSSummary.h.

Constructor & Destructor Documentation

casa::MSSummary::MSSummary ( const MeasurementSet & )

Constructor.

casa::MSSummary::MSSummary ( const MeasurementSet * )

casa::MSSummary::MSSummary	(	const MeasurementSet *	ms,
		const String	msname
	)

casa::MSSummary::~MSSummary ( )

Destructor.

Member Function Documentation

void casa::MSSummary::clearFlags ( LogIO & os ) const [private]

Clear formatting flags.

void casa::MSSummary::getScanSummary ( Record & outRec ) const

Return a Record with information derived from the main table.

void casa::MSSummary::getSpectralWindowInfo ( Record & outRec ) const

void casa::MSSummary::list	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List all header information.

void casa::MSSummary::list	(	LogIO &	os,
		Record &	outRec,
		Bool	verbose = `False`,
		Bool	fillRecord = `True`
	)		const

Return some useful info in a record too along with os.

void casa::MSSummary::listAntenna	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List subtables.

void casa::MSSummary::listFeed	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listField	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listField	(	LogIO &	os,
		Record &	outRec,
		Bool	verbose = `False`,
		Bool	fillRecord = `True`
	)		const

void casa::MSSummary::listHistory ( LogIO & os ) const

void casa::MSSummary::listHow	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List how data were obtained (SpectralWindow, Feed, and Antenna tables)

void casa::MSSummary::listMain	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List main table.

void casa::MSSummary::listMain	(	LogIO &	os,
		Record &	outRec,
		Bool	verbose = `False`,
		Bool	fillRecord = `True`
	)		const

Return some useful info in a record too along with os.

void casa::MSSummary::listObservation	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listPolarization	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listSource	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listSpectralAndPolInfo	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listSpectralWindow	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listSysCal	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listTables	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List table size summary.

void casa::MSSummary::listTitle ( LogIO & os ) const

List a title for the Summary.

void casa::MSSummary::listWeather	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

void casa::MSSummary::listWhat	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List what was observed (Field and Main tables)

void casa::MSSummary::listWhat	(	LogIO &	os,
		Record &	outRec,
		Bool	verbose = `False`,
		Bool	fillRecord = `True`
	)		const

void casa::MSSummary::listWhere	(	LogIO &	os,
		Bool	verbose = `False`
	)		const

List convenient groupings of tables: list where MS obtained (Observation and Array tables)

String casa::MSSummary::name ( ) const

Retrieve image name.

Int casa::MSSummary::nrow ( ) const

Retrieve number of rows.

void casa::MSSummary::setListUnflaggedRowCount ( Bool v ) [inline]

Definition at line 158 of file MSSummary.h.

References _listUnflaggedRowCount.

void casa::MSSummary::setMetaDataCacheSizeInMB ( Float cacheSize ) [inline]

set the cache size, in MB, for the MSMetaData object.

Definition at line 161 of file MSSummary.h.

References _cacheSizeMB.

Bool casa::MSSummary::setMS ( const MeasurementSet & ms )

Set a new MS.

Member Data Documentation

Float casa::MSSummary::_cacheSizeMB [private]

Definition at line 181 of file MSSummary.h.

Referenced by setMetaDataCacheSizeInMB().

Bool casa::MSSummary::_listUnflaggedRowCount [private]

Definition at line 179 of file MSSummary.h.

Referenced by setListUnflaggedRowCount().

std::auto_ptr<MSMetaData> casa::MSSummary::_msmd [private]

Definition at line 165 of file MSSummary.h.

const String casa::MSSummary::dashlin1 [private]

Formatting strings.

Definition at line 168 of file MSSummary.h.

const String casa::MSSummary::dashlin2 [private]

Definition at line 168 of file MSSummary.h.

String casa::MSSummary::msname_p [private]

Name of the MS used in the constructor.

Definition at line 177 of file MSSummary.h.

Vector<Int> casa::MSSummary::nVisPerField_ [mutable, private]

For keeping track of the number of vis per field.

Definition at line 174 of file MSSummary.h.

const MeasurementSet* casa::MSSummary::pMS [private]

Pointer to MS.

Definition at line 164 of file MSSummary.h.

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

casacore/ms/MeasurementSets/MSSummary.h

Public Member Functions

Private Member Functions

Private Attributes