MSSummary.h

Classes

MSSummary -- Provides and lists information about the header of an image (full description)

class MSSummary

Interface

Public Members
MSSummary (const MeasurementSet&)
~MSSummary()
Int nrow() const
String name() const
Bool setMS (const MeasurementSet& ms)
void list (LogIO& os, Bool verbose=False) const
void listTitle (LogIO& os) const
void listWhere (LogIO& os, Bool verbose=False) const
void listWhat (LogIO& os, Bool verbose=False) const
void listHow (LogIO& os, Bool verbose=False) const
void listMain (LogIO& os, Bool verbose=False) const
void listAntenna (LogIO& os, Bool verbose=False) const
void listFeed (LogIO& os, Bool verbose=False) const
void listField (LogIO& os, Bool verbose=False) 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 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
Private Members
void clearFlags (LogIO& os) const

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

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.

To Do

Member Description

MSSummary (const MeasurementSet&)

Constructor

~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 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 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 listAntenna (LogIO& os, Bool verbose=False) const
void listFeed (LogIO& os, Bool verbose=False) const
void listField (LogIO& os, Bool verbose=False) 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 listSpectralAndPolInfo (LogIO& os, Bool verbose=False) const
void listSysCal (LogIO& os, Bool verbose=False) const
void listWeather (LogIO& os, Bool verbose=False) const

List subtables

void listTables (LogIO& os, Bool verbose=False) const

List table size summary

void clearFlags (LogIO& os) const

Clear formatting flags