Loading...
Searching...
No Matches
MSSpWindowIndex.h
Go to the documentation of this file.
//# MSSpWindowIndex: index/lookup in a MeasurementSet SPECTRAL_WINDOW subtable
//# Copyright (C) 2000,2001,2002
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_MSSPWINDOWINDEX_H
#define MS_MSSPWINDOWINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MFrequency.h>
#include <casacore/ms/MeasurementSets/MSSpectralWindow.h>
#include <casacore/ms/MeasurementSets/MSSpWindowColumns.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# forward declarations
// <summary>
// Class to handle lookup or indexing into a MS SPECTRAL_WINDOW subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSSpWindowription
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "SPECTRAL_WINDOW subtable" and "index".
// </etymology>
//
// <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.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// SPECTRAL_WINDOW subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSSpWindowIndex
{
public:
// Construct from an MS SPECTRAL_WINDOW subtable
MSSpWindowIndex(const MSSpectralWindow& spectralWindow);
// Null destructor
virtual ~MSSpWindowIndex() {}
// Look up SPECTRAL_WINDOW_ID's for a given frequency group or groups
Vector<Int> matchFreqGrp(const Int& freqGrp);
Vector<Int> matchFreqGrp(const Vector<Int>& freqGrps);
// Look up SPECTRAL_WINDOW_ID's for a given frequency group name
Vector<Int> matchFreqGrpName(const String& freqGrpName);
// Look up SPECTRAL_WINDOW_ID's for a given frequency axis sampling
Vector<Int> matchFreq(const Vector<MFrequency>& chanFreq,
const Vector<MVFrequency>& chanWidth,
const Double& freqTol);
private:
// Disallow null constructor
MSSpWindowIndex();
// SPECTRAL_WINDOW subtable column accessor
MSSpWindowColumns msSpWindowCols_p;
// Vector cache of SpWindow id's
Vector<Int> spWindowIds_p;
Int nrows_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSSpWindowColumns
Definition MSSpWindowColumns.h:81
casacore::MSSpWindowIndex::matchFreqGrp
Vector< Int > matchFreqGrp(const Vector< Int > &freqGrps)
casacore::MSSpWindowIndex::MSSpWindowIndex
MSSpWindowIndex(const MSSpectralWindow &spectralWindow)
Construct from an MS SPECTRAL_WINDOW subtable.
casacore::MSSpWindowIndex::matchFreqGrp
Vector< Int > matchFreqGrp(const Int &freqGrp)
Look up SPECTRAL_WINDOW_ID's for a given frequency group or groups.
casacore::MSSpWindowIndex::~MSSpWindowIndex
virtual ~MSSpWindowIndex()
Null destructor.
Definition MSSpWindowIndex.h:87
casacore::MSSpWindowIndex::msSpWindowCols_p
MSSpWindowColumns msSpWindowCols_p
SPECTRAL_WINDOW subtable column accessor.
Definition MSSpWindowIndex.h:106
casacore::MSSpWindowIndex::MSSpWindowIndex
MSSpWindowIndex()
Disallow null constructor.
casacore::MSSpWindowIndex::matchFreq
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.
casacore::MSSpWindowIndex::spWindowIds_p
Vector< Int > spWindowIds_p
Vector cache of SpWindow id's.
Definition MSSpWindowIndex.h:109
casacore::MSSpWindowIndex::nrows_p
Int nrows_p
Definition MSSpWindowIndex.h:110
casacore::MSSpWindowIndex::matchFreqGrpName
Vector< Int > matchFreqGrpName(const String &freqGrpName)
Look up SPECTRAL_WINDOW_ID's for a given frequency group name.
casacore::MSSpectralWindow
Definition MSSpectralWindow.h:77
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Int
int Int
Definition aipstype.h:48
casacore::Double
double Double
Definition aipstype.h:53