MSSpwIndex.h

Classes

MSSpwIndex -- Class to handle lookup or indexing into a MS Data_Desc_ID and SpectralWindow subtables (full description)

class MSSpwIndex

Types

enum MODES

EXACT = 1
APPROX
RANGE

Interface

Public Members
MSSpwIndex(const MSSpectralWindow& msSpw)
virtual ~MSSpwIndex()
Vector<Int> matchName(const String& name)
Vector<Int> matchName(const Vector<String>& names)
Vector<Int> matchFrequencyRange(const Float f0,const Float f1,Bool approx)
Vector<Int> matchRegexOrPattern(const String& pattern, const Bool regex=False)
Vector<Int> matchId(const Vector<Int>& spwIds)
Vector<Int> matchIDLT(const Int n)
Vector<Int> matchIDGT(const Int n)
Vector<Int> matchIDGTAndLT(const Int n0, const int n1)
Vector<Float> convertToHz(const Float f0, const Float f1, const String& unit)
Private Members
MSSpwIndex()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

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

Synopsis

This class provides lookup and two level indexing into an MS DataDescription and SpectralWindow subtable. These services include returning list of integer data description IDs (DDID), given a list of Spectral window IDs or frequencies. The DDIDs are then used for selecting rows from the MS (since DDIDs are the primary keys in the maintable - not the spectral window IDs).

Example

Motivation

Collect together all subtable indexing and lookup for the data description and spectral window subtable, for encapsulation and efficiency.

Thrown Exceptions

Member Description

MSSpwIndex(const MSSpectralWindow& msSpw)

Construct from an MS FIELD subtable

virtual ~MSSpwIndex()

Null destructor

Vector<Int> matchName(const String& name)

Look up FIELD_ID's for a given field name, or set of field names

Vector<Int> matchName(const Vector<String>& names)

Vector<Int> matchFrequencyRange(const Float f0,const Float f1,Bool approx)

Vector<Int> matchRegexOrPattern(const String& pattern, const Bool regex=False)

Look up FIELD_ID's for a given pattern/regex for source name/code

Vector<Int> matchId(const Vector<Int>& spwIds)

Look up FIELD_ID's for a given source id

Vector<Int> matchIDLT(const Int n)

Vector<Int> matchIDGT(const Int n)

Vector<Int> matchIDGTAndLT(const Int n0, const int n1)

Vector<Float> convertToHz(const Float f0, const Float f1, const String& unit)

MSSpwIndex()

Construct from an MS FIELD subtable

enum MODES

ROMSDataDescColumns msDataDescSubTable_p;