Loading...
Searching...
No Matches
MSAntennaIndex.h
Go to the documentation of this file.
//# MSAntennaIndex: index or lookup in a MeasurementSet ANTENNA 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_MSANTENNAINDEX_H
#define MS_MSANTENNAINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSAntenna.h>
#include <casacore/ms/MeasurementSets/MSAntennaColumns.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 ANTENNA subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSAntenna
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "ANTENNA subtable" and "index".
// </etymology>
//
// <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.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// ANTENNA subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSAntennaIndex
{
public:
// Construct from an MS ANTENNA subtable
MSAntennaIndex(const MSAntenna &antenna);
// Null destructor
virtual ~MSAntennaIndex() {}
// Look up ANTENNA_ID's for a given a regular expression or pattern
Vector<Int> matchAntennaRegexOrPattern(const String& pattern, const Bool regex=False);
// Look up ANTENNA_ID's for a given antenna name, or set of antenna names
Vector<Int> matchAntennaName(const String& name);
Vector<Int> matchAntennaName(const Vector<String>& names);
// Look up ANTENNA_ID's for a given antenna station
Vector<Int> matchStationRegexOrPattern(const String& pattern, const Bool regex=False);
Vector<Int> matchStationName(const String& station);
Vector<Int> matchStationName(const Vector<String>& station);
// Look up ANTENNA_ID's for a given antenna and station name pair
Vector<Int> matchAntennaNameAndStation(const String& name,
const String& station);
Vector<Int> matchId(const Vector<Int>& sourceId);
private:
// Default constructor
MSAntennaIndex();
// ANTENNA subtable column accessor
MSAntennaColumns msAntennaCols_p;
// Vector cache of antenna id's
Vector<Int> antennaIds_p, stationIds_p;
Int nrows_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSAntennaColumns
Definition MSAntennaColumns.h:78
casacore::MSAntennaIndex::matchAntennaName
Vector< Int > matchAntennaName(const String &name)
Look up ANTENNA_ID's for a given antenna name, or set of antenna names.
casacore::MSAntennaIndex::matchAntennaRegexOrPattern
Vector< Int > matchAntennaRegexOrPattern(const String &pattern, const Bool regex=False)
Look up ANTENNA_ID's for a given a regular expression or pattern.
casacore::MSAntennaIndex::~MSAntennaIndex
virtual ~MSAntennaIndex()
Null destructor.
Definition MSAntennaIndex.h:86
casacore::MSAntennaIndex::nrows_p
Int nrows_p
Definition MSAntennaIndex.h:112
casacore::MSAntennaIndex::matchStationName
Vector< Int > matchStationName(const Vector< String > &station)
casacore::MSAntennaIndex::stationIds_p
Vector< Int > stationIds_p
Definition MSAntennaIndex.h:111
casacore::MSAntennaIndex::matchId
Vector< Int > matchId(const Vector< Int > &sourceId)
casacore::MSAntennaIndex::matchAntennaNameAndStation
Vector< Int > matchAntennaNameAndStation(const String &name, const String &station)
Look up ANTENNA_ID's for a given antenna and station name pair.
casacore::MSAntennaIndex::matchStationName
Vector< Int > matchStationName(const String &station)
casacore::MSAntennaIndex::matchStationRegexOrPattern
Vector< Int > matchStationRegexOrPattern(const String &pattern, const Bool regex=False)
Look up ANTENNA_ID's for a given antenna station.
casacore::MSAntennaIndex::MSAntennaIndex
MSAntennaIndex(const MSAntenna &antenna)
Construct from an MS ANTENNA subtable.
casacore::MSAntennaIndex::antennaIds_p
Vector< Int > antennaIds_p
Vector cache of antenna id's.
Definition MSAntennaIndex.h:111
casacore::MSAntennaIndex::MSAntennaIndex
MSAntennaIndex()
Default constructor.
casacore::MSAntennaIndex::msAntennaCols_p
MSAntennaColumns msAntennaCols_p
ANTENNA subtable column accessor.
Definition MSAntennaIndex.h:108
casacore::MSAntennaIndex::matchAntennaName
Vector< Int > matchAntennaName(const Vector< String > &names)
casacore::MSAntenna
Definition MSAntenna.h:78
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::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