casacore
MSFieldIndex.h
Go to the documentation of this file.
1 //# MSFieldIndex: index or lookup in a MeasurementSet FIELD subtable
2 //# Copyright (C) 2000,2001
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //#
27 //# $Id$
28 
29 #ifndef MS_MSFIELDINDEX_H
30 #define MS_MSFIELDINDEX_H
31 
32 //# includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/ms/MeasurementSets/MSField.h>
35 #include <casacore/ms/MSSel/MSSelectionError.h>
36 #include <casacore/ms/MeasurementSets/MSFieldColumns.h>
37 #include <casacore/casa/Arrays/Vector.h>
38 #include <casacore/casa/BasicSL/String.h>
39 
40 namespace casacore { //# NAMESPACE CASACORE - BEGIN
41 
42 //# forward declarations
43 
44 // <summary>
45 // Class to handle lookup or indexing into a MS FIELD subtable
46 // </summary>
47 
48 // <use visibility=export>
49 //
50 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
51 // </reviewed>
52 
53 // <prerequisite>
54 // <li> MeasurementSet
55 // <li> MSField
56 // </prerequisite>
57 //
58 // <etymology>
59 // From "MeasurementSet", "FIELD subtable" and "index".
60 // </etymology>
61 //
62 // <synopsis>
63 // This class provides lookup and indexing into an MS FIELD
64 // subtable. These services include returning rows numbers
65 // (which for the FIELD subtable are FIELD_ID's) associated
66 // with specific data in the subtable.
67 // </synopsis>
68 //
69 // <example>
70 // </example>
71 //
72 // <motivation>
73 // Collect together all subtable indexing and lookup for the
74 // FIELD subtable, for encapsulation and efficiency.
75 // </motivation>
76 //
77 // <thrown>
78 // <li>
79 // <li>
80 // </thrown>
81 //
82 
84 {
85 public:
86  // Construct from an MS FIELD subtable
87  MSFieldIndex(const MSField &field);
88 
89  // Null destructor
90  virtual ~MSFieldIndex() {}
91 
92  // Look up a single name in FIELD.NAME or FIELD.CODE
94  // Look up FIELD_ID's for a given field name, or set of field names
97 
98  //ADD for file name wildcard selection
100 
101  // Look up FIELD_ID's for a given pattern/regex for source name/code
103  const Bool regex=False);
105  const Bool regex=False);
107  const Bool regex=False);
108  // Look up FIELD_ID's for a given source id
109  Vector<Int> matchSourceId(const Int& sourceId);
113 
114  // Add for field code selection
116 
118 
121  Vector<Int> matchFieldIDGTAndLT(const Int n0, const int n1);
122 private:
123  // Disallow null constructor
125 
126  // FIELD subtable column accessor
128 
129  // Vector cache of field id's
132 };
133 
134 
135 } //# NAMESPACE CASACORE - END
136 
137 #endif
138 
Vector< Int > matchFieldIDGT(const Int n)
Vector< Int > matchSourceId(const Int &sourceId)
Look up FIELD_ID's for a given source id.
MSFieldColumns msFieldCols_p
FIELD subtable column accessor.
Definition: MSFieldIndex.h:127
Vector< Int > maskFieldIDs(const Vector< Int > &ids)
Vector< Int > matchFieldCodeRegexOrPattern(const String &pattern, const Bool regex=False)
MSFieldIndex()
Disallow null constructor.
Vector< Int > matchFieldNameOrCode(const String &name)
Look up a single name in FIELD.NAME or FIELD.CODE.
Vector< Int > fieldIds_p
Vector cache of field id's.
Definition: MSFieldIndex.h:130
Vector< Int > matchFieldIDLT(const Int n)
MSFieldIndex(const MSField &field)
Construct from an MS FIELD subtable.
Vector< Int > matchFieldName(const Vector< String > &names)
Vector< Int > matchFieldCode(const String &code)
Add for field code selection.
Vector< Int > matchSourceId(const Vector< Int > &sourceIds)
Vector< Int > matchFieldName(const String &name)
Look up FIELD_ID's for a given field name, or set of field names.
void matchIdAgainstNames(Vector< Int > &ids)
Vector< Int > validateIndices(const Vector< Int > &sourceIds)
Vector< Int > matchFieldNameRegexOrPattern(const String &pattern, const Bool regex=False)
Vector< Int > matchSubFieldName(const String &name)
ADD for file name wildcard selection.
Vector< Int > matchFieldIDGTAndLT(const Int n0, const int n1)
Vector< Int > matchFieldRegexOrPattern(const String &pattern, const Bool regex=False)
Look up FIELD_ID's for a given pattern/regex for source name/code.
virtual ~MSFieldIndex()
Null destructor.
Definition: MSFieldIndex.h:90
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
TableExprNode pattern(const TableExprNode &node)
Definition: ExprNode.h:1487
const Bool False
Definition: aipstype.h:44
TableExprNode regex(const TableExprNode &node)
Functions for regular expression matching and pattern matching.
Definition: ExprNode.h:1483
int Int
Definition: aipstype.h:50
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42