casacore
MSPolEnums.h
Go to the documentation of this file.
1 //# MSPolarizationEnums.h: Definitions for the MeasurementSet POLARIZATION table
2 //# Copyright (C) 1999,2000
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_MSPOLENUMS_H
30 #define MS_MSPOLENUMS_H
31 
32 #include <casacore/casa/aips.h>
33 
34 namespace casacore { //# NAMESPACE CASACORE - BEGIN
35 
36 // <use visibility=export>
37 
38 // <summary> Enums for the MeasurementSet POLARIZATION table </summary>
39 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
40 // </reviewed>
41 // <etymology>
42 // This class contains the enums for the MeasurementSet POLARIZATION table
43 // </etymology>
44 // <synopsis>
45 // This class does nothing. It is merely a container for the enumerations
46 // used by the MSPolarization class. These enumerations define the
47 // standard columns and keywords.
48 // </synopsis>
49 
50 // <example>
51 // See the documentation for MeasurementSet for examples on the use of these
52 // enumerations.
53 // </example>
54 // <todo asof="1999/01/14">
55 // All the todo items which may be related to this class are
56 // grouped with the todo items for MeasurementSet
57 // </todo>
58 //
59 
61 public:
62  // The POLARIZATION table colums with predefined meaning.
63  // Keys: POLARIZATION_ID is rownumber
65  // "True" columns are defined.<BR>
66  // TYPE - UNIT - MEASURE
68  // A pair of integers for each correlation product specifying the receptors
69  // from which the signal originated. E.g., (0,1) = receptor 0 on feed1 and
70  // receptor 1 on feed2. This is unused for I,Q,U,V data.<BR>
71  // Int(2, NUM_CORR)
73  // The polarization type for each correlation product, as a Stokes enum. <BR>
74  // Int(NUM_CORR)
76  // Row flag <BR>
77  // Bool
79  // Number of correlations. <BR>
80  // Int
82  // Number of required columns <BR>
84  // Not a column, but just a final enum specifying the number of enums.
86  };
87 
88  // Keywords with a predefined meaning
90  //
91  // "True" keywords are defined.
93  //
94  // Not a keyword, but just a final enum specifying the number of enums.
96  };
97 };
98 
99 } //# NAMESPACE CASACORE - END
100 
101 #endif
Enums for the MeasurementSet POLARIZATION table.
Definition: MSPolEnums.h:60
PredefinedColumns
The POLARIZATION table colums with predefined meaning.
Definition: MSPolEnums.h:64
@ UNDEFINED_COLUMN
"True" columns are defined.
Definition: MSPolEnums.h:67
@ NUMBER_REQUIRED_COLUMNS
Number of required columns
Definition: MSPolEnums.h:83
@ CORR_PRODUCT
A pair of integers for each correlation product specifying the receptors from which the signal origin...
Definition: MSPolEnums.h:72
@ NUM_CORR
Number of correlations.
Definition: MSPolEnums.h:81
@ CORR_TYPE
The polarization type for each correlation product, as a Stokes enum.
Definition: MSPolEnums.h:75
@ NUMBER_PREDEFINED_COLUMNS
Not a column, but just a final enum specifying the number of enums.
Definition: MSPolEnums.h:85
@ FLAG_ROW
Row flag Bool.
Definition: MSPolEnums.h:78
PredefinedKeywords
Keywords with a predefined meaning.
Definition: MSPolEnums.h:89
@ UNDEFINED_KEYWORD
"True" keywords are defined.
Definition: MSPolEnums.h:92
@ NUMBER_PREDEFINED_KEYWORDS
Not a keyword, but just a final enum specifying the number of enums.
Definition: MSPolEnums.h:95
this file contains all the compiler specific defines
Definition: mainpage.dox:28