Loading...
Searching...
No Matches
MSFieldIndex.h
Go to the documentation of this file.
//# MSFieldIndex: index or lookup in a MeasurementSet FIELD subtable
//# 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_MSFIELDINDEX_H
#define MS_MSFIELDINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSField.h>
#include <casacore/ms/MSSel/MSSelectionError.h>
#include <casacore/ms/MeasurementSets/MSFieldColumns.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 FIELD subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSField
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "FIELD subtable" and "index".
// </etymology>
//
// <synopsis>
// This class provides lookup and indexing into an MS FIELD
// subtable. These services include returning rows numbers
// (which for the FIELD subtable are FIELD_ID's) associated
// with specific data in the subtable.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// FIELD subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSFieldIndex
{
public:
// Construct from an MS FIELD subtable
MSFieldIndex(const MSField &field);
// Null destructor
virtual ~MSFieldIndex() {}
// Look up a single name in FIELD.NAME or FIELD.CODE
Vector<Int> matchFieldNameOrCode(const String& name);
// Look up FIELD_ID's for a given field name, or set of field names
Vector<Int> matchFieldName(const String& name);
Vector<Int> matchFieldName(const Vector<String>& names);
//ADD for file name wildcard selection
Vector<Int> matchSubFieldName(const String& name);
// Look up FIELD_ID's for a given pattern/regex for source name/code
Vector<Int> matchFieldRegexOrPattern(const String& pattern,
const Bool regex=False);
Vector<Int> matchFieldNameRegexOrPattern(const String& pattern,
const Bool regex=False);
Vector<Int> matchFieldCodeRegexOrPattern(const String& pattern,
const Bool regex=False);
// Look up FIELD_ID's for a given source id
Vector<Int> matchSourceId(const Int& sourceId);
Vector<Int> matchSourceId(const Vector<Int>& sourceIds);
void matchIdAgainstNames(Vector<Int>& ids);
Vector<Int> validateIndices(const Vector<Int>& sourceIds);
// Add for field code selection
Vector<Int> matchFieldCode(const String& code);
Vector<Int> maskFieldIDs(const Vector<Int>& ids);
Vector<Int> matchFieldIDLT(const Int n);
Vector<Int> matchFieldIDGT(const Int n);
Vector<Int> matchFieldIDGTAndLT(const Int n0, const int n1);
private:
// Disallow null constructor
MSFieldIndex();
// FIELD subtable column accessor
MSFieldColumns msFieldCols_p;
// Vector cache of field id's
Vector<Int> fieldIds_p;
Int nrows_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSFieldColumns
Definition MSFieldColumns.h:86
casacore::MSFieldIndex::matchFieldRegexOrPattern
Vector< Int > matchFieldRegexOrPattern(const String &pattern, const Bool regex=False)
Look up FIELD_ID's for a given pattern/regex for source name/code.
casacore::MSFieldIndex::matchFieldName
Vector< Int > matchFieldName(const Vector< String > &names)
casacore::MSFieldIndex::matchFieldIDGT
Vector< Int > matchFieldIDGT(const Int n)
casacore::MSFieldIndex::matchFieldName
Vector< Int > matchFieldName(const String &name)
Look up FIELD_ID's for a given field name, or set of field names.
casacore::MSFieldIndex::matchSourceId
Vector< Int > matchSourceId(const Int &sourceId)
Look up FIELD_ID's for a given source id.
casacore::MSFieldIndex::msFieldCols_p
MSFieldColumns msFieldCols_p
FIELD subtable column accessor.
Definition MSFieldIndex.h:124
casacore::MSFieldIndex::matchFieldCodeRegexOrPattern
Vector< Int > matchFieldCodeRegexOrPattern(const String &pattern, const Bool regex=False)
casacore::MSFieldIndex::matchFieldIDLT
Vector< Int > matchFieldIDLT(const Int n)
casacore::MSFieldIndex::maskFieldIDs
Vector< Int > maskFieldIDs(const Vector< Int > &ids)
casacore::MSFieldIndex::MSFieldIndex
MSFieldIndex()
Disallow null constructor.
casacore::MSFieldIndex::fieldIds_p
Vector< Int > fieldIds_p
Vector cache of field id's.
Definition MSFieldIndex.h:127
casacore::MSFieldIndex::MSFieldIndex
MSFieldIndex(const MSField &field)
Construct from an MS FIELD subtable.
casacore::MSFieldIndex::matchFieldCode
Vector< Int > matchFieldCode(const String &code)
Add for field code selection.
casacore::MSFieldIndex::nrows_p
Int nrows_p
Definition MSFieldIndex.h:128
casacore::MSFieldIndex::matchSourceId
Vector< Int > matchSourceId(const Vector< Int > &sourceIds)
casacore::MSFieldIndex::matchFieldNameRegexOrPattern
Vector< Int > matchFieldNameRegexOrPattern(const String &pattern, const Bool regex=False)
casacore::MSFieldIndex::matchFieldNameOrCode
Vector< Int > matchFieldNameOrCode(const String &name)
Look up a single name in FIELD.NAME or FIELD.CODE.
casacore::MSFieldIndex::matchSubFieldName
Vector< Int > matchSubFieldName(const String &name)
ADD for file name wildcard selection.
casacore::MSFieldIndex::matchIdAgainstNames
void matchIdAgainstNames(Vector< Int > &ids)
casacore::MSFieldIndex::validateIndices
Vector< Int > validateIndices(const Vector< Int > &sourceIds)
casacore::MSFieldIndex::matchFieldIDGTAndLT
Vector< Int > matchFieldIDGTAndLT(const Int n0, const int n1)
casacore::MSFieldIndex::~MSFieldIndex
virtual ~MSFieldIndex()
Null destructor.
Definition MSFieldIndex.h:87
casacore::MSField
Definition MSField.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::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