casacore
MSPolIndex.h
Go to the documentation of this file.
1 //# MSPolIndex: index or lookup in an MS POLARIZATION subtable
2 //# Copyright (C) 2000,2001,2002
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_MSPOLINDEX_H
30 #define MS_MSPOLINDEX_H
31 
32 //# includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/ms/MeasurementSets/MSPolarization.h>
35 #include <casacore/ms/MeasurementSets/MSPolColumns.h>
36 #include <casacore/casa/Arrays/Vector.h>
37 #include <casacore/casa/Arrays/Matrix.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 an MS POLARIZATION 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> MSPolarization
56 // </prerequisite>
57 //
58 // <etymology>
59 // From "MeasurementSet", "POLARIZATION subtable" and "index".
60 // </etymology>
61 //
62 // <synopsis>
63 // This class provides lookup and indexing into an MS POLARIZATION
64 // subtable. These services include returning rows numbers
65 // (which for the POLARIZATION subtable are POLARIZATION_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 // POLARIZATION 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 POLARIZATION subtable
87  MSPolarizationIndex(const MSPolarization& polarizationTable);
88 
89  // Null destructor
90  virtual ~MSPolarizationIndex() {}
91 
92  // Look up POLARIZATION_ID's for a given set of polarization correlation
93  // types and receptor cross-products
95  const Matrix<Int>& corrProduct);
96  // /////////////////// Add for MS selection //////////////////////////////
97  // Only Look up POLARIZATION_ID's for a given set of polarization correlation
98  // types
99  Vector<Int> matchCorrType(const Vector<Int>& corrType,Bool exactMatch=True);
100 
101 private:
102  // Disallow null constructor
104 
105  // POLARIZATION subtable column accessor
107 
108  // Vector cache of polarization id's
111 };
112 
113 
114 } //# NAMESPACE CASACORE - END
115 
116 #endif
117 
MSPolarizationColumns msPolarizationCols_p
POLARIZATION subtable column accessor.
Definition: MSPolIndex.h:106
Vector< Int > polarizationIds_p
Vector cache of polarization id's.
Definition: MSPolIndex.h:109
Vector< Int > matchCorrType(const Vector< Int > &corrType, Bool exactMatch=True)
/////////////////// Add for MS selection ////////////////////////////// Only Look up POLARIZATION_ID'...
MSPolarizationIndex(const MSPolarization &polarizationTable)
Construct from an MS POLARIZATION subtable.
virtual ~MSPolarizationIndex()
Null destructor.
Definition: MSPolIndex.h:90
Vector< Int > matchCorrTypeAndProduct(const Vector< Int > &corrType, const Matrix< Int > &corrProduct)
Look up POLARIZATION_ID's for a given set of polarization correlation types and receptor cross-produc...
MSPolarizationIndex()
Disallow null constructor.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
int Int
Definition: aipstype.h:50
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
const Bool True
Definition: aipstype.h:43