Loading...
Searching...
No Matches
MSSpwIndex.h
Go to the documentation of this file.
//# MSSpwIndex: index or lookup in a MeasurementSet subtable (DDID and SPW)
//# Copyright (C) 2000,2001
//# 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_MSSPWINDEX_H
#define MS_MSSPWINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicSL/String.h>
#include <casacore/ms/MeasurementSets/MSColumns.h>
#include <casacore/casa/Arrays/Matrix.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# forward declarations
// <summary>
// Class to handle lookup or indexing into a MS Data_Desc_ID
// and SpectralWindow subtables
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "SpectralWindwo subtable" and "index".
// </etymology>
//
// <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).
//
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the data
// description and spectral window subtable, for encapsulation and
// efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSSpwIndex
{
public:
enum MSSpwTypes {MSSPW_INDEXRANGE=0,MSSPW_INDEX=2, MSSPW_UNITHZ=4, MSSPW_UNITVELOCITY=5};
// Construct from an MS FIELD subtable
MSSpwIndex(const MSSpectralWindow& msSpw);
// Null destructor
virtual ~MSSpwIndex() {};
// Look up FIELD_ID's for a given field name, or set of field names
Vector<Int> matchName(const String& name);
Vector<Int> matchName(const Vector<String>& names);
void matchNameAsIntID(Vector<int>& list);
Vector<Int> matchFrequencyRange(const Float f0,const Float f1,Bool approx, const Float f3=0);
// A version of match freq range that does not throw an exception but returns
// false if no match...else spw, start, nchan returns the matches
// f0 and f1 are in Hz and the match is done in the frame defined in the
// SpectralWindow table.
Bool matchFrequencyRange(const Double f0, const Double f1,
Vector<Int>& spw, Vector<Int>& start,
Vector<Int>& nchan);
// Look up FIELD_ID's for a given pattern/regex for source name/code
Vector<Int> matchRegexOrPattern(const String& pattern,
const Bool regex=False);
// Look up FIELD_ID's for a given source id
Vector<Int> matchId(const Vector<Int>& spwIds);
Vector<Int> matchLT(const Int n);
Vector<Int> matchGT(const Int n);
Vector<Int> matchGTAndLT(const Int n0, const int n1);
Vector<Int> matchLT(const Float*);
Vector<Int> matchGT(const Float*);
Vector<Int> matchGTAndLT(const Float* phyValMin, const Float *phyValMax);
Vector<Float> convertToMKS(const Float f0, const Float f1, const String& unit);
Vector<Int> convertToChannelIndex(const Vector<Int>& spw, const Vector<Float>& freqList,
Int& nFSpec);
Vector<Int> convertToSpwIndex(const Vector<Float>& freqList,
Int &nFSpec);
private:
Int findChanIndex_p(const Float& freq, const Vector<Double>& chanFreqList,
const Bool& greaterThan,
const Bool& ascendingOrder);
// Construct from an MS FIELD subtable
MSSpwIndex();
// FIELD subtable column accessor
MSSpWindowColumns msSpwSubTable_p;
// MSDataDescColumns msDataDescSubTable_p;
enum MODES {EXACT=1, APPROX, RANGE};
Vector<Int> spwIDs;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSSpWindowColumns
Definition MSSpWindowColumns.h:81
casacore::MSSpectralWindow
Definition MSSpectralWindow.h:77
casacore::MSSpwIndex::matchGT
Vector< Int > matchGT(const Int n)
casacore::MSSpwIndex::matchFrequencyRange
Bool matchFrequencyRange(const Double f0, const Double f1, Vector< Int > &spw, Vector< Int > &start, Vector< Int > &nchan)
A version of match freq range that does not throw an exception but returns false if no match....
casacore::MSSpwIndex::matchGTAndLT
Vector< Int > matchGTAndLT(const Float *phyValMin, const Float *phyValMax)
casacore::MSSpwIndex::matchFrequencyRange
Vector< Int > matchFrequencyRange(const Float f0, const Float f1, Bool approx, const Float f3=0)
casacore::MSSpwIndex::MSSpwIndex
MSSpwIndex(const MSSpectralWindow &msSpw)
Construct from an MS FIELD subtable.
casacore::MSSpwIndex::matchName
Vector< Int > matchName(const String &name)
Look up FIELD_ID's for a given field name, or set of field names.
casacore::MSSpwIndex::convertToSpwIndex
Vector< Int > convertToSpwIndex(const Vector< Float > &freqList, Int &nFSpec)
casacore::MSSpwIndex::matchNameAsIntID
void matchNameAsIntID(Vector< int > &list)
casacore::MSSpwIndex::findChanIndex_p
Int findChanIndex_p(const Float &freq, const Vector< Double > &chanFreqList, const Bool &greaterThan, const Bool &ascendingOrder)
casacore::MSSpwIndex::matchName
Vector< Int > matchName(const Vector< String > &names)
casacore::MSSpwIndex::matchLT
Vector< Int > matchLT(const Int n)
casacore::MSSpwIndex::MSSpwIndex
MSSpwIndex()
Construct from an MS FIELD subtable.
casacore::MSSpwIndex::matchRegexOrPattern
Vector< Int > matchRegexOrPattern(const String &pattern, const Bool regex=False)
Look up FIELD_ID's for a given pattern/regex for source name/code.
casacore::MSSpwIndex::matchGTAndLT
Vector< Int > matchGTAndLT(const Int n0, const int n1)
casacore::MSSpwIndex::MODES
MODES
MSDataDescColumns msDataDescSubTable_p;.
Definition MSSpwIndex.h:135
casacore::MSSpwIndex::APPROX
@ APPROX
Definition MSSpwIndex.h:135
casacore::MSSpwIndex::RANGE
@ RANGE
Definition MSSpwIndex.h:135
casacore::MSSpwIndex::EXACT
@ EXACT
Definition MSSpwIndex.h:135
casacore::MSSpwIndex::convertToMKS
Vector< Float > convertToMKS(const Float f0, const Float f1, const String &unit)
casacore::MSSpwIndex::matchLT
Vector< Int > matchLT(const Float *)
casacore::MSSpwIndex::matchId
Vector< Int > matchId(const Vector< Int > &spwIds)
Look up FIELD_ID's for a given source id.
casacore::MSSpwIndex::msSpwSubTable_p
MSSpWindowColumns msSpwSubTable_p
FIELD subtable column accessor.
Definition MSSpwIndex.h:133
casacore::MSSpwIndex::matchGT
Vector< Int > matchGT(const Float *)
casacore::MSSpwIndex::MSSpwTypes
MSSpwTypes
Definition MSSpwIndex.h:87
casacore::MSSpwIndex::MSSPW_UNITVELOCITY
@ MSSPW_UNITVELOCITY
Definition MSSpwIndex.h:87
casacore::MSSpwIndex::MSSPW_UNITHZ
@ MSSPW_UNITHZ
Definition MSSpwIndex.h:87
casacore::MSSpwIndex::MSSPW_INDEXRANGE
@ MSSPW_INDEXRANGE
Definition MSSpwIndex.h:87
casacore::MSSpwIndex::MSSPW_INDEX
@ MSSPW_INDEX
Definition MSSpwIndex.h:87
casacore::MSSpwIndex::spwIDs
Vector< Int > spwIDs
Definition MSSpwIndex.h:136
casacore::MSSpwIndex::~MSSpwIndex
virtual ~MSSpwIndex()
Null destructor.
Definition MSSpwIndex.h:93
casacore::MSSpwIndex::convertToChannelIndex
Vector< Int > convertToChannelIndex(const Vector< Int > &spw, const Vector< Float > &freqList, Int &nFSpec)
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::pattern
TableExprNode pattern(const TableExprNode &node)
Definition ExprNode.h:1491
casacore::False
const Bool False
Definition aipstype.h:42
casacore::Float
float Float
Definition aipstype.h:52
casacore::name
String name() const
Return the name of the field.
Definition RecordField.h:163
casacore::regex
TableExprNode regex(const TableExprNode &node)
Functions for regular expression matching and pattern matching.
Definition ExprNode.h:1487
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::Double
double Double
Definition aipstype.h:53