casacore
MSMainEnums.h
Go to the documentation of this file.
1 //# MSMainEnums.h: Class with definitions for the main MeasurementSet table
2 //# Copyright (C) 1996,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_MSMAINENUMS_H
30 #define MS_MSMAINENUMS_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 main table </summary>
39 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
40 // </reviewed>
41 // <etymology>
42 // This class contains the enum defininitions for the main MeasurementSet
43 // table.
44 // </etymology>
45 
46 // <synopsis>
47 // This class does nothing. It is merely a container for the enumerations
48 // used by the MeasurementSet class. These enumerations define the
49 // standard columns, keywords.
50 // </synopsis>
51 
52 // <example>
53 // See the documentation for MeasurementSet for examples on the use of these
54 // enumerations.
55 // </example>
56 // <todo asof="1999/02/04">
57 // All the todo items which may be related to this class are
58 // grouped with the todo items for MeasurementSet
59 // </todo>
60 //
61 
62 class MSMainEnums {
63 public:
64  // The Main table colums with predefined meaning.
66  // "True" columns are defined. <BR>
67  // TYPE - UNIT - MEASURE
69  //
70  // ID of first antenna in antenna-pair. This is a key into the
71  // ANTENNA table. Ranges from 0 to NUM_ANT-1.<BR>
72  // Int
74  //
75  // ID of second antenna in antenna-pair. For SD ANTENNA1==ANTENNA2<BR>
76  // Int
78  //
79  // ARRAY id.<BR>
80  // Int.
82  //
83  // Data description id <BR>
84  // Int.
86  //
87  // Effective integration time (i.e.<=INTERVAL)<BR>
88  // Double - s.
90  //
91  // Feed id on ANTENNA1.<BR>
92  // Int.
94  //
95  // Feed id on ANTENNA2.<BR>
96  // Int.
98  //
99  // Unique id for this pointing (or drift scan)<BR>
100  // Int
102  //
103  // The data flags, array of bools with same shape as data.
104  // Data is flagged bad if FLAG is True.<BR>
105  // Bool(Nc, Nf)
107  //
108  // Flag category, allows for multiple categories of flagging, which can
109  // selectively be reset. The cumulative effect is reflected in FLAG.
110  // This column should have an attached keyword CATEGORY which is a
111  // String (Ncat) of categories (e.g, ONLINE, FLAG_CMD, INTERACTIVE) <BR>
112  // Bool (Nc, Nf, Ncat)
114  //
115  // Flag all data in this row if True.<BR>
116  // Bool
118  //
119  // The extent of this sample, sampling interval.<BR>
120  // Double - s.
122  //
123  // Index into OBSERVATION table. <BR>
124  // Int.
126  //
127  // Processor Id, points to PROCESSOR table with information on the
128  // correlator or backend setup. <BR>
129  // Int
131  //
132  // Scan number.
133  // Int.
135  //
136  // Estimated rms noise for channel with unity bandpass response.<BR>
137  // Float(Nc) - Same units as the DATA column.
139  //
140  // State Id, points to STATE table with info on current observing mode,
141  // calibration and reference signals etc. (Mainly single dish) <BR>
142  // Int
144  //
145  // Modified Julian Day number (JD-2400000.5) for midpoint of integration.
146  // For high precision timing, add the value from TIME_EXTRA_PREC.<BR>
147  // Double - s - EPOCH.
149  //
150  // Modified Julian Day number (JD-2400000.5) for centroid of integration.
151  // Double - s - EPOCH.
153  //
154  // UVW coordinates.<BR>
155  // Double(3) - m - UVW.
156  UVW,
157  //
158  // Weight of spectrum. This is the weight assigned by the correlator and
159  // does NOT get overwritten by e.g. imaging tasks that do weighting.<BR>
160  // Float(Nc).
162  //
163  // Not a column, but just an enum specifying the number of required columns.
164  //# Note: first enum after this one should be assigned value of this enum.
166  //
167  // Antenna3 - for triple correlations products. <BR>
168  // Int
170  //
171  // Reference antenna for this baseline, True for ANTENNA1 <BR>
172  // Bool
174  //
175  // The Corrected complex visibility data (optional). <BR>
176  // Complex(Nc, Nf)
178  //
179  // Complex visibility matrix. The UNITS are unspecified to allow
180  // for the calibrated data to show up as a DATA column as well but in
181  // a calibrated MS.<BR>
182  // Complex(Nc, Nf)
184  //
185  // Feed id on ANTENNA3 <BR>
186  // Int
188  //
189  // Floating point data column. For simple single dish work this can be used
190  // instead of the complex DATA column. <BR>
191  // Float(Nc, Nf)
193  //
194  // The imaging weights (optional). <BR>
195  // Float(Nf)
197  //
198  // Complex correlation function or lag spectrum for each correlation
199  // product <BR>
200  // Complex(Nc, Nl)
202  //
203  // The model visibility data (optional). <BR>
204  // Complex(Nc,Nf)
206  //
207  // Switching phase Id <BR>
208  // Int
210  //
211  // For a pulsar the correlations are assumed to be measured for a
212  // limited number of pulse phase bins. This is the particular bin for
213  // which this data was measured. (optional) <BR>
214  // Int.
216  //
217  // Unique id for this pulsar gate. Index into PULSAR_GATE table.
218  // (optional) <BR>
219  // Int.
221  //
222  // Estimated rms noise for each data point. To be used instead of
223  // SIGMA if present. <BR>
224  // Float(Nc,Nf) - Same units as the DATA column.
226  //
227  // Additional precision for TIME if required. Add this to TIME to obtain
228  // the exact EPOCH.<BR>
229  // Double - s.
231  //
232  // UVW for second pair of triple correlation product. <BR>
233  // Double(3) - m
235  //
236  // Zero frequency point - needed for transform back to lag domain <BR>
237  // Complex(Nc)
239  //
240  // Weight for each channel. To be used instead of WEIGHT if present.<BR>
241  // Float(Nf).
243  // Corrected Weight for each channel. If present can be used with corrected_data<BR>
244  // Float(Nf).
246  //
247  // Not a column, but just a final enum specifying the number of enums.
249  };
250 
251  // Keywords with a predefined meaning
253  //
254  // "True" keywords are defined.
256  //
257  // Antenna subtable. Antenna positions, mount-types etc.
259  // Data Description subtable. Gives spectral window and polarization id.
261  // Feed subtable. Responses, offsets, beams etc.
263  // Field subtable. Position etc. for each pointing.
265  // Flag command subtable. List of flag commands.
267  // History information subtable.
269  // MS Version number. <BR>
270  // Float.
272  // Observation subtable. Project, observer, schedule.
274  // Pointing information subtable.
276  // Polarization setup information subtable.
278  // Back-end processor information subtable. Description of correlator etc.
280  // Spectral window subtable. Frequencies, bandwidths, polarizations.
282  // State subtable. Observing modes and states (cal, ref etc.)
284  // Not a keyword, but an enum specifying the number of required keywords
285  // The last required keyword should be set to this enum
287  // Calibration tables associated with this MS. <BR>
288  // Table(NUM_CAL_TABLES)
290  // Doppler tracking information subtable.
292  // Frequency offset information subtable.
294  // Listing of sort columns for each sorted table. <BR>
295  // String(NUM_SORTED_TABLES)
297  // Listing of sort orders for each sorted table. <BR>
298  // String(NUM_SORTED_TABLES)
300  // Sorted reference tables of the main table. First one is main table.<BR>
301  // Table(NUM_SORTED_TABLES)
303  // Source subtable. Positions etc. for each source.
305  // SysCal subtable. System calibration data (Tsys etc.)
307  // Weather subtable. Weather info for each antenna.
309  // Not a keyword, but just a final enum specifying the number of enums.
311  };
312 };
313 
314 } //# NAMESPACE CASACORE - END
315 
316 #endif
317 
Enums for the MeasurementSet main table.
Definition: MSMainEnums.h:62
PredefinedColumns
The Main table colums with predefined meaning.
Definition: MSMainEnums.h:65
@ PROCESSOR_ID
Processor Id, points to PROCESSOR table with information on the correlator or backend setup.
Definition: MSMainEnums.h:130
@ FLAG_ROW
Flag all data in this row if True.
Definition: MSMainEnums.h:117
@ INTERVAL
The extent of this sample, sampling interval.
Definition: MSMainEnums.h:121
@ FLAG_CATEGORY
Flag category, allows for multiple categories of flagging, which can selectively be reset.
Definition: MSMainEnums.h:113
@ BASELINE_REF
Reference antenna for this baseline, True for ANTENNA1 Bool.
Definition: MSMainEnums.h:173
@ FLAG
The data flags, array of bools with same shape as data.
Definition: MSMainEnums.h:106
@ ANTENNA2
ID of second antenna in antenna-pair.
Definition: MSMainEnums.h:77
@ IMAGING_WEIGHT
The imaging weights (optional).
Definition: MSMainEnums.h:196
@ NUMBER_REQUIRED_COLUMNS
Not a column, but just an enum specifying the number of required columns.
Definition: MSMainEnums.h:165
@ FIELD_ID
Unique id for this pointing (or drift scan) Int.
Definition: MSMainEnums.h:101
@ UVW2
UVW for second pair of triple correlation product.
Definition: MSMainEnums.h:234
@ SIGMA_SPECTRUM
Estimated rms noise for each data point.
Definition: MSMainEnums.h:225
@ OBSERVATION_ID
Index into OBSERVATION table.
Definition: MSMainEnums.h:125
@ PHASE_ID
Switching phase Id Int.
Definition: MSMainEnums.h:209
@ ANTENNA3
Antenna3 - for triple correlations products.
Definition: MSMainEnums.h:169
@ WEIGHT_SPECTRUM
Weight for each channel.
Definition: MSMainEnums.h:242
@ WEIGHT
Weight of spectrum.
Definition: MSMainEnums.h:161
@ SIGMA
Estimated rms noise for channel with unity bandpass response.
Definition: MSMainEnums.h:138
@ FEED2
Feed id on ANTENNA2.
Definition: MSMainEnums.h:97
@ STATE_ID
State Id, points to STATE table with info on current observing mode, calibration and reference signal...
Definition: MSMainEnums.h:143
@ TIME_EXTRA_PREC
Additional precision for TIME if required.
Definition: MSMainEnums.h:230
@ VIDEO_POINT
Zero frequency point - needed for transform back to lag domain Complex(Nc)
Definition: MSMainEnums.h:238
@ PULSAR_GATE_ID
Unique id for this pulsar gate.
Definition: MSMainEnums.h:220
@ CORRECTED_WEIGHT_SPECTRUM
Corrected Weight for each channel.
Definition: MSMainEnums.h:245
@ TIME_CENTROID
Modified Julian Day number (JD-2400000.5) for centroid of integration.
Definition: MSMainEnums.h:152
@ SCAN_NUMBER
Scan number.
Definition: MSMainEnums.h:134
@ EXPOSURE
Effective integration time (i.e.
Definition: MSMainEnums.h:89
@ ANTENNA1
ID of first antenna in antenna-pair.
Definition: MSMainEnums.h:73
@ LAG_DATA
Complex correlation function or lag spectrum for each correlation product Complex(Nc,...
Definition: MSMainEnums.h:201
@ DATA
Complex visibility matrix.
Definition: MSMainEnums.h:183
@ CORRECTED_DATA
The Corrected complex visibility data (optional).
Definition: MSMainEnums.h:177
@ FEED3
Feed id on ANTENNA3 Int.
Definition: MSMainEnums.h:187
@ PULSAR_BIN
For a pulsar the correlations are assumed to be measured for a limited number of pulse phase bins.
Definition: MSMainEnums.h:215
@ FLOAT_DATA
Floating point data column.
Definition: MSMainEnums.h:192
@ NUMBER_PREDEFINED_COLUMNS
Not a column, but just a final enum specifying the number of enums.
Definition: MSMainEnums.h:248
@ FEED1
Feed id on ANTENNA1.
Definition: MSMainEnums.h:93
@ UNDEFINED_COLUMN
"True" columns are defined.
Definition: MSMainEnums.h:68
@ TIME
Modified Julian Day number (JD-2400000.5) for midpoint of integration.
Definition: MSMainEnums.h:148
@ MODEL_DATA
The model visibility data (optional).
Definition: MSMainEnums.h:205
@ UVW
UVW coordinates.
Definition: MSMainEnums.h:156
@ DATA_DESC_ID
Data description id Int.
Definition: MSMainEnums.h:85
PredefinedKeywords
Keywords with a predefined meaning.
Definition: MSMainEnums.h:252
@ SPECTRAL_WINDOW
Spectral window subtable.
Definition: MSMainEnums.h:281
@ FEED
Feed subtable.
Definition: MSMainEnums.h:262
@ SORT_ORDER
Listing of sort orders for each sorted table.
Definition: MSMainEnums.h:299
@ SORTED_TABLES
Sorted reference tables of the main table.
Definition: MSMainEnums.h:302
@ FLAG_CMD
Flag command subtable.
Definition: MSMainEnums.h:266
@ NUMBER_REQUIRED_KEYWORDS
Not a keyword, but an enum specifying the number of required keywords The last required keyword shoul...
Definition: MSMainEnums.h:286
@ SOURCE
Source subtable.
Definition: MSMainEnums.h:304
@ NUMBER_PREDEFINED_KEYWORDS
Not a keyword, but just a final enum specifying the number of enums.
Definition: MSMainEnums.h:310
@ MS_VERSION
MS Version number.
Definition: MSMainEnums.h:271
@ UNDEFINED_KEYWORD
"True" keywords are defined.
Definition: MSMainEnums.h:255
@ PROCESSOR
Back-end processor information subtable.
Definition: MSMainEnums.h:279
@ HISTORY
History information subtable.
Definition: MSMainEnums.h:268
@ OBSERVATION
Observation subtable.
Definition: MSMainEnums.h:273
@ POLARIZATION
Polarization setup information subtable.
Definition: MSMainEnums.h:277
@ SYSCAL
SysCal subtable.
Definition: MSMainEnums.h:306
@ ANTENNA
Antenna subtable.
Definition: MSMainEnums.h:258
@ DOPPLER
Doppler tracking information subtable.
Definition: MSMainEnums.h:291
@ POINTING
Pointing information subtable.
Definition: MSMainEnums.h:275
@ WEATHER
Weather subtable.
Definition: MSMainEnums.h:308
@ FIELD
Field subtable.
Definition: MSMainEnums.h:264
@ FREQ_OFFSET
Frequency offset information subtable.
Definition: MSMainEnums.h:293
@ CAL_TABLES
Calibration tables associated with this MS.
Definition: MSMainEnums.h:289
@ DATA_DESCRIPTION
Data Description subtable.
Definition: MSMainEnums.h:260
@ STATE
State subtable.
Definition: MSMainEnums.h:283
@ SORT_COLUMNS
Listing of sort columns for each sorted table.
Definition: MSMainEnums.h:296
this file contains all the compiler specific defines
Definition: mainpage.dox:28