casacore::MSAntennaIndex Class Reference

Class to handle lookup or indexing into a MS ANTENNA subtable. More...

#include <MSAntennaIndex.h>

Public Member Functions
	MSAntennaIndex (const MSAntenna &antenna)
	Construct from an MS ANTENNA subtable. More...
virtual	~MSAntennaIndex ()
	Null destructor. More...
Vector< Int >	matchAntennaRegexOrPattern (const String &pattern, const Bool regex=False)
	Look up ANTENNA_ID's for a given a regular expression or pattern. More...
Vector< Int >	matchAntennaName (const String &name)
	Look up ANTENNA_ID's for a given antenna name, or set of antenna names. More...
Vector< Int >	matchAntennaName (const Vector< String > &names)
Vector< Int >	matchStationRegexOrPattern (const String &pattern, const Bool regex=False)
	Look up ANTENNA_ID's for a given antenna station. More...
Vector< Int >	matchStationName (const String &station)
Vector< Int >	matchStationName (const Vector< String > &station)
Vector< Int >	matchAntennaNameAndStation (const String &name, const String &station)
	Look up ANTENNA_ID's for a given antenna and station name pair. More...
Vector< Int >	matchId (const Vector< Int > &sourceId)

Private Member Functions
	MSAntennaIndex ()
	Default constructor. More...

Private Attributes
MSAntennaColumns	msAntennaCols_p
	ANTENNA subtable column accessor. More...
Vector< Int >	antennaIds_p
	Vector cache of antenna id's. More...
Vector< Int >	stationIds_p
Int	nrows_p

Detailed Description

Class to handle lookup or indexing into a MS ANTENNA subtable.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• MeasurementSet
• MSAntenna

Etymology

From "MeasurementSet", "ANTENNA subtable" and "index".

Synopsis

This class provides lookup and indexing into an MS ANTENNA subtable. These services include returning rows numbers (which for the ANTENNA subtable are ANTENNA_ID's) associated with specific data in the subtable.

Example

Motivation

Collect together all subtable indexing and lookup for the ANTENNA subtable, for encapsulation and efficiency.

Thrown Exceptions

Definition at line 82 of file MSAntennaIndex.h.

Constructor & Destructor Documentation

casacore::MSAntennaIndex::MSAntennaIndex

(

const MSAntenna &

antenna

)

Construct from an MS ANTENNA subtable.

virtual casacore::MSAntennaIndex::~MSAntennaIndex ( )

inlinevirtual

Null destructor.

Definition at line 89 of file MSAntennaIndex.h.

casacore::MSAntennaIndex::MSAntennaIndex ( )

private

Default constructor.

Member Function Documentation

Vector<Int> casacore::MSAntennaIndex::matchAntennaName

(

const String &

name

)

Look up ANTENNA_ID's for a given antenna name, or set of antenna names.

Vector<Int> casacore::MSAntennaIndex::matchAntennaName

(

const Vector< String > &

names

)

Vector<Int> casacore::MSAntennaIndex::matchAntennaNameAndStation	(	const String &	name,
		const String &	station
	)

Look up ANTENNA_ID's for a given antenna and station name pair.

Vector<Int> casacore::MSAntennaIndex::matchAntennaRegexOrPattern	(	const String &	pattern,
		const Bool	regex = False
	)

Look up ANTENNA_ID's for a given a regular expression or pattern.

Vector<Int> casacore::MSAntennaIndex::matchId

(

const Vector< Int > &

sourceId

)

Vector<Int> casacore::MSAntennaIndex::matchStationName

(

const String &

station

)

Vector<Int> casacore::MSAntennaIndex::matchStationName

(

const Vector< String > &

station

)

Vector<Int> casacore::MSAntennaIndex::matchStationRegexOrPattern	(	const String &	pattern,
		const Bool	regex = False
	)

Look up ANTENNA_ID's for a given antenna station.

Member Data Documentation

Vector<Int> casacore::MSAntennaIndex::antennaIds_p

private

Vector cache of antenna id's.

Definition at line 114 of file MSAntennaIndex.h.

MSAntennaColumns casacore::MSAntennaIndex::msAntennaCols_p

private

ANTENNA subtable column accessor.

Definition at line 111 of file MSAntennaIndex.h.

Int casacore::MSAntennaIndex::nrows_p

private

Definition at line 115 of file MSAntennaIndex.h.

Vector<Int> casacore::MSAntennaIndex::stationIds_p

private

Definition at line 114 of file MSAntennaIndex.h.

---

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

• ms/MSSel/MSAntennaIndex.h