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