MSSpWindowIndex.h

Classes

MSSpWindowIndex -- Class to handle lookup or indexing into a MS SPECTRAL_WINDOW subtable (full description)

class MSSpWindowIndex

Interface

Public Members
MSSpWindowIndex(const MSSpectralWindow& spectralWindow)
virtual ~MSSpWindowIndex()
Vector<Int> matchFreqGrp(const Int& freqGrp)
Vector<Int> matchFreqGrp(const Vector<Int>& freqGrps)
Vector<Int> matchFreqGrpName(const String& freqGrpName)
Vector<Int> matchFreq(const Vector<MFrequency>& chanFreq, const Vector<MVFrequency>& chanWidth, const Double& freqTol)
Private Members
MSSpWindowIndex()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

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

Synopsis

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

Example

Motivation

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

Thrown Exceptions

Member Description

MSSpWindowIndex(const MSSpectralWindow& spectralWindow)

Construct from an MS SPECTRAL_WINDOW subtable

virtual ~MSSpWindowIndex()

Null destructor

Vector<Int> matchFreqGrp(const Int& freqGrp)

Look up SPECTRAL_WINDOW_ID's for a given frequency group or groups

Vector<Int> matchFreqGrp(const Vector<Int>& freqGrps)

Vector<Int> matchFreqGrpName(const String& freqGrpName)

Look up SPECTRAL_WINDOW_ID's for a given frequency group name

Vector<Int> matchFreq(const Vector<MFrequency>& chanFreq, const Vector<MVFrequency>& chanWidth, const Double& freqTol)

Look up SPECTRAL_WINDOW_ID's for a given frequency axis sampling

MSSpWindowIndex()

Disallow null constructor