Loading...
Searching...
No Matches
MSMainEnums.h
Go to the documentation of this file.
//# MSMainEnums.h: Class with definitions for the main MeasurementSet table
//# Copyright (C) 1996,1999,2000
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_MSMAINENUMS_H
#define MS_MSMAINENUMS_H
#include <casacore/casa/aips.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <use visibility=export>
// <summary> Enums for the MeasurementSet main table </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <etymology>
// This class contains the enum defininitions for the main MeasurementSet
// table.
// </etymology>
// <synopsis>
// This class does nothing. It is merely a container for the enumerations
// used by the MeasurementSet class. These enumerations define the
// standard columns, keywords.
// </synopsis>
// <example>
// See the documentation for MeasurementSet for examples on the use of these
// enumerations.
// </example>
// <todo asof="1999/02/04">
// All the todo items which may be related to this class are
// grouped with the todo items for MeasurementSet
// </todo>
//
class MSMainEnums {
public:
// The Main table colums with predefined meaning.
enum PredefinedColumns {
// "True" columns are defined. <BR>
// TYPE - UNIT - MEASURE
UNDEFINED_COLUMN=0,
//
// ID of first antenna in antenna-pair. This is a key into the
// ANTENNA table. Ranges from 0 to NUM_ANT-1.<BR>
// Int
ANTENNA1,
//
// ID of second antenna in antenna-pair. For SD ANTENNA1==ANTENNA2<BR>
// Int
ANTENNA2,
//
// ARRAY id.<BR>
// Int.
ARRAY_ID,
//
// Data description id <BR>
// Int.
DATA_DESC_ID,
//
// Effective integration time (i.e.<=INTERVAL)<BR>
// Double - s.
EXPOSURE,
//
// Feed id on ANTENNA1.<BR>
// Int.
FEED1,
//
// Feed id on ANTENNA2.<BR>
// Int.
FEED2,
//
// Unique id for this pointing (or drift scan)<BR>
// Int
FIELD_ID,
//
// The data flags, array of bools with same shape as data.
// Data is flagged bad if FLAG is True.<BR>
// Bool(Nc, Nf)
FLAG,
//
// Flag category, allows for multiple categories of flagging, which can
// selectively be reset. The cumulative effect is reflected in FLAG.
// This column should have an attached keyword CATEGORY which is a
// String (Ncat) of categories (e.g, ONLINE, FLAG_CMD, INTERACTIVE) <BR>
// Bool (Nc, Nf, Ncat)
FLAG_CATEGORY,
//
// Flag all data in this row if True.<BR>
// Bool
FLAG_ROW,
//
// The extent of this sample, sampling interval.<BR>
// Double - s.
INTERVAL,
//
// Index into OBSERVATION table. <BR>
// Int.
OBSERVATION_ID,
//
// Processor Id, points to PROCESSOR table with information on the
// correlator or backend setup. <BR>
// Int
PROCESSOR_ID,
//
// Scan number.
// Int.
SCAN_NUMBER,
//
// Estimated rms noise for channel with unity bandpass response.<BR>
// Float(Nc) - Same units as the DATA column.
SIGMA,
//
// State Id, points to STATE table with info on current observing mode,
// calibration and reference signals etc. (Mainly single dish) <BR>
// Int
STATE_ID,
//
// Modified Julian Day number (JD-2400000.5) for midpoint of integration.
// For high precision timing, add the value from TIME_EXTRA_PREC.<BR>
// Double - s - EPOCH.
TIME,
//
// Modified Julian Day number (JD-2400000.5) for centroid of integration.
// Double - s - EPOCH.
TIME_CENTROID,
//
// UVW coordinates.<BR>
// Double(3) - m - UVW.
UVW,
//
// Weight of spectrum. This is the weight assigned by the correlator and
// does NOT get overwritten by e.g. imaging tasks that do weighting.<BR>
// Float(Nc).
WEIGHT,
//
// Not a column, but just an enum specifying the number of required columns.
//# Note: first enum after this one should be assigned value of this enum.
NUMBER_REQUIRED_COLUMNS=WEIGHT,
//
// Antenna3 - for triple correlations products. <BR>
// Int
ANTENNA3,
//
// Reference antenna for this baseline, True for ANTENNA1 <BR>
// Bool
BASELINE_REF,
//
// The Corrected complex visibility data (optional). <BR>
// Complex(Nc, Nf)
CORRECTED_DATA,
//
// Complex visibility matrix. The UNITS are unspecified to allow
// for the calibrated data to show up as a DATA column as well but in
// a calibrated MS.<BR>
// Complex(Nc, Nf)
DATA,
//
// Feed id on ANTENNA3 <BR>
// Int
FEED3,
//
// Floating point data column. For simple single dish work this can be used
// instead of the complex DATA column. <BR>
// Float(Nc, Nf)
FLOAT_DATA,
//
// The imaging weights (optional). <BR>
// Float(Nf)
IMAGING_WEIGHT,
//
// Complex correlation function or lag spectrum for each correlation
// product <BR>
// Complex(Nc, Nl)
LAG_DATA,
//
// The model visibility data (optional). <BR>
// Complex(Nc,Nf)
MODEL_DATA,
//
// Switching phase Id <BR>
// Int
PHASE_ID,
//
// For a pulsar the correlations are assumed to be measured for a
// limited number of pulse phase bins. This is the particular bin for
// which this data was measured. (optional) <BR>
// Int.
PULSAR_BIN,
//
// Unique id for this pulsar gate. Index into PULSAR_GATE table.
// (optional) <BR>
// Int.
PULSAR_GATE_ID,
//
// Estimated rms noise for each data point. To be used instead of
// SIGMA if present. <BR>
// Float(Nc,Nf) - Same units as the DATA column.
SIGMA_SPECTRUM,
//
// Additional precision for TIME if required. Add this to TIME to obtain
// the exact EPOCH.<BR>
// Double - s.
TIME_EXTRA_PREC,
//
// UVW for second pair of triple correlation product. <BR>
// Double(3) - m
UVW2,
//
// Zero frequency point - needed for transform back to lag domain <BR>
// Complex(Nc)
VIDEO_POINT,
//
// Weight for each channel. To be used instead of WEIGHT if present.<BR>
// Float(Nf).
WEIGHT_SPECTRUM,
// Corrected Weight for each channel. If present can be used with corrected_data<BR>
// Float(Nf).
CORRECTED_WEIGHT_SPECTRUM,
//
// Not a column, but just a final enum specifying the number of enums.
NUMBER_PREDEFINED_COLUMNS=CORRECTED_WEIGHT_SPECTRUM
};
// Keywords with a predefined meaning
enum PredefinedKeywords {
//
// "True" keywords are defined.
UNDEFINED_KEYWORD=0,
//
// Antenna subtable. Antenna positions, mount-types etc.
ANTENNA,
// Data Description subtable. Gives spectral window and polarization id.
DATA_DESCRIPTION,
// Feed subtable. Responses, offsets, beams etc.
FEED,
// Field subtable. Position etc. for each pointing.
FIELD,
// Flag command subtable. List of flag commands.
FLAG_CMD,
// History information subtable.
HISTORY,
// MS Version number. <BR>
// Float.
MS_VERSION,
// Observation subtable. Project, observer, schedule.
OBSERVATION,
// Pointing information subtable.
POINTING,
// Polarization setup information subtable.
POLARIZATION,
// Back-end processor information subtable. Description of correlator etc.
PROCESSOR,
// Spectral window subtable. Frequencies, bandwidths, polarizations.
SPECTRAL_WINDOW,
// State subtable. Observing modes and states (cal, ref etc.)
STATE,
// Not a keyword, but an enum specifying the number of required keywords
// The last required keyword should be set to this enum
NUMBER_REQUIRED_KEYWORDS=STATE,
// Calibration tables associated with this MS. <BR>
// Table(NUM_CAL_TABLES)
CAL_TABLES,
// Doppler tracking information subtable.
DOPPLER,
// Frequency offset information subtable.
FREQ_OFFSET,
// Listing of sort columns for each sorted table. <BR>
// String(NUM_SORTED_TABLES)
SORT_COLUMNS,
// Listing of sort orders for each sorted table. <BR>
// String(NUM_SORTED_TABLES)
SORT_ORDER,
// Sorted reference tables of the main table. First one is main table.<BR>
// Table(NUM_SORTED_TABLES)
SORTED_TABLES,
// Source subtable. Positions etc. for each source.
SOURCE,
// SysCal subtable. System calibration data (Tsys etc.)
SYSCAL,
// Weather subtable. Weather info for each antenna.
WEATHER,
// Not a keyword, but just a final enum specifying the number of enums.
NUMBER_PREDEFINED_KEYWORDS=WEATHER
};
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSMainEnums
Enums for the MeasurementSet main table.
Definition MSMainEnums.h:59
casacore::MSMainEnums::PredefinedColumns
PredefinedColumns
The Main table colums with predefined meaning.
Definition MSMainEnums.h:62
casacore::MSMainEnums::PROCESSOR_ID
@ PROCESSOR_ID
Processor Id, points to PROCESSOR table with information on the correlator or backend setup.
Definition MSMainEnums.h:127
casacore::MSMainEnums::FLAG_ROW
@ FLAG_ROW
Flag all data in this row if True.
Definition MSMainEnums.h:114
casacore::MSMainEnums::INTERVAL
@ INTERVAL
The extent of this sample, sampling interval.
Definition MSMainEnums.h:118
casacore::MSMainEnums::FLAG_CATEGORY
@ FLAG_CATEGORY
Flag category, allows for multiple categories of flagging, which can selectively be reset.
Definition MSMainEnums.h:110
casacore::MSMainEnums::BASELINE_REF
@ BASELINE_REF
Reference antenna for this baseline, True for ANTENNA1 Bool.
Definition MSMainEnums.h:170
casacore::MSMainEnums::FLAG
@ FLAG
The data flags, array of bools with same shape as data.
Definition MSMainEnums.h:103
casacore::MSMainEnums::ANTENNA2
@ ANTENNA2
ID of second antenna in antenna-pair.
Definition MSMainEnums.h:74
casacore::MSMainEnums::IMAGING_WEIGHT
@ IMAGING_WEIGHT
The imaging weights (optional).
Definition MSMainEnums.h:193
casacore::MSMainEnums::NUMBER_REQUIRED_COLUMNS
@ NUMBER_REQUIRED_COLUMNS
Not a column, but just an enum specifying the number of required columns.
Definition MSMainEnums.h:162
casacore::MSMainEnums::FIELD_ID
@ FIELD_ID
Unique id for this pointing (or drift scan) Int.
Definition MSMainEnums.h:98
casacore::MSMainEnums::UVW2
@ UVW2
UVW for second pair of triple correlation product.
Definition MSMainEnums.h:231
casacore::MSMainEnums::SIGMA_SPECTRUM
@ SIGMA_SPECTRUM
Estimated rms noise for each data point.
Definition MSMainEnums.h:222
casacore::MSMainEnums::OBSERVATION_ID
@ OBSERVATION_ID
Index into OBSERVATION table.
Definition MSMainEnums.h:122
casacore::MSMainEnums::PHASE_ID
@ PHASE_ID
Switching phase Id Int.
Definition MSMainEnums.h:206
casacore::MSMainEnums::ANTENNA3
@ ANTENNA3
Antenna3 - for triple correlations products.
Definition MSMainEnums.h:166
casacore::MSMainEnums::WEIGHT_SPECTRUM
@ WEIGHT_SPECTRUM
Weight for each channel.
Definition MSMainEnums.h:239
casacore::MSMainEnums::WEIGHT
@ WEIGHT
Weight of spectrum.
Definition MSMainEnums.h:158
casacore::MSMainEnums::SIGMA
@ SIGMA
Estimated rms noise for channel with unity bandpass response.
Definition MSMainEnums.h:135
casacore::MSMainEnums::FEED2
@ FEED2
Feed id on ANTENNA2.
Definition MSMainEnums.h:94
casacore::MSMainEnums::STATE_ID
@ STATE_ID
State Id, points to STATE table with info on current observing mode, calibration and reference signal...
Definition MSMainEnums.h:140
casacore::MSMainEnums::TIME_EXTRA_PREC
@ TIME_EXTRA_PREC
Additional precision for TIME if required.
Definition MSMainEnums.h:227
casacore::MSMainEnums::VIDEO_POINT
@ VIDEO_POINT
Zero frequency point - needed for transform back to lag domain Complex(Nc).
Definition MSMainEnums.h:235
casacore::MSMainEnums::PULSAR_GATE_ID
@ PULSAR_GATE_ID
Unique id for this pulsar gate.
Definition MSMainEnums.h:217
casacore::MSMainEnums::CORRECTED_WEIGHT_SPECTRUM
@ CORRECTED_WEIGHT_SPECTRUM
Corrected Weight for each channel.
Definition MSMainEnums.h:242
casacore::MSMainEnums::TIME_CENTROID
@ TIME_CENTROID
Modified Julian Day number (JD-2400000.5) for centroid of integration.
Definition MSMainEnums.h:149
casacore::MSMainEnums::SCAN_NUMBER
@ SCAN_NUMBER
Scan number.
Definition MSMainEnums.h:131
casacore::MSMainEnums::EXPOSURE
@ EXPOSURE
Effective integration time (i.e.
Definition MSMainEnums.h:86
casacore::MSMainEnums::ANTENNA1
@ ANTENNA1
ID of first antenna in antenna-pair.
Definition MSMainEnums.h:70
casacore::MSMainEnums::LAG_DATA
@ LAG_DATA
Complex correlation function or lag spectrum for each correlation product Complex(Nc,...
Definition MSMainEnums.h:198
casacore::MSMainEnums::DATA
@ DATA
Complex visibility matrix.
Definition MSMainEnums.h:180
casacore::MSMainEnums::CORRECTED_DATA
@ CORRECTED_DATA
The Corrected complex visibility data (optional).
Definition MSMainEnums.h:174
casacore::MSMainEnums::FEED3
@ FEED3
Feed id on ANTENNA3 Int.
Definition MSMainEnums.h:184
casacore::MSMainEnums::PULSAR_BIN
@ PULSAR_BIN
For a pulsar the correlations are assumed to be measured for a limited number of pulse phase bins.
Definition MSMainEnums.h:212
casacore::MSMainEnums::FLOAT_DATA
@ FLOAT_DATA
Floating point data column.
Definition MSMainEnums.h:189
casacore::MSMainEnums::NUMBER_PREDEFINED_COLUMNS
@ NUMBER_PREDEFINED_COLUMNS
Not a column, but just a final enum specifying the number of enums.
Definition MSMainEnums.h:245
casacore::MSMainEnums::FEED1
@ FEED1
Feed id on ANTENNA1.
Definition MSMainEnums.h:90
casacore::MSMainEnums::UNDEFINED_COLUMN
@ UNDEFINED_COLUMN
"True" columns are defined.
Definition MSMainEnums.h:65
casacore::MSMainEnums::TIME
@ TIME
Modified Julian Day number (JD-2400000.5) for midpoint of integration.
Definition MSMainEnums.h:145
casacore::MSMainEnums::MODEL_DATA
@ MODEL_DATA
The model visibility data (optional).
Definition MSMainEnums.h:202
casacore::MSMainEnums::UVW
@ UVW
UVW coordinates.
Definition MSMainEnums.h:153
casacore::MSMainEnums::ARRAY_ID
@ ARRAY_ID
ARRAY id.
Definition MSMainEnums.h:78
casacore::MSMainEnums::DATA_DESC_ID
@ DATA_DESC_ID
Data description id Int.
Definition MSMainEnums.h:82
casacore::MSMainEnums::PredefinedKeywords
PredefinedKeywords
Keywords with a predefined meaning.
Definition MSMainEnums.h:249
casacore::MSMainEnums::SPECTRAL_WINDOW
@ SPECTRAL_WINDOW
Spectral window subtable.
Definition MSMainEnums.h:278
casacore::MSMainEnums::FEED
@ FEED
Feed subtable.
Definition MSMainEnums.h:259
casacore::MSMainEnums::SORT_ORDER
@ SORT_ORDER
Listing of sort orders for each sorted table.
Definition MSMainEnums.h:296
casacore::MSMainEnums::SORTED_TABLES
@ SORTED_TABLES
Sorted reference tables of the main table.
Definition MSMainEnums.h:299
casacore::MSMainEnums::FLAG_CMD
@ FLAG_CMD
Flag command subtable.
Definition MSMainEnums.h:263
casacore::MSMainEnums::NUMBER_REQUIRED_KEYWORDS
@ NUMBER_REQUIRED_KEYWORDS
Not a keyword, but an enum specifying the number of required keywords The last required keyword shoul...
Definition MSMainEnums.h:283
casacore::MSMainEnums::SOURCE
@ SOURCE
Source subtable.
Definition MSMainEnums.h:301
casacore::MSMainEnums::NUMBER_PREDEFINED_KEYWORDS
@ NUMBER_PREDEFINED_KEYWORDS
Not a keyword, but just a final enum specifying the number of enums.
Definition MSMainEnums.h:307
casacore::MSMainEnums::MS_VERSION
@ MS_VERSION
MS Version number.
Definition MSMainEnums.h:268
casacore::MSMainEnums::UNDEFINED_KEYWORD
@ UNDEFINED_KEYWORD
"True" keywords are defined.
Definition MSMainEnums.h:252
casacore::MSMainEnums::PROCESSOR
@ PROCESSOR
Back-end processor information subtable.
Definition MSMainEnums.h:276
casacore::MSMainEnums::HISTORY
@ HISTORY
History information subtable.
Definition MSMainEnums.h:265
casacore::MSMainEnums::OBSERVATION
@ OBSERVATION
Observation subtable.
Definition MSMainEnums.h:270
casacore::MSMainEnums::POLARIZATION
@ POLARIZATION
Polarization setup information subtable.
Definition MSMainEnums.h:274
casacore::MSMainEnums::SYSCAL
@ SYSCAL
SysCal subtable.
Definition MSMainEnums.h:303
casacore::MSMainEnums::ANTENNA
@ ANTENNA
Antenna subtable.
Definition MSMainEnums.h:255
casacore::MSMainEnums::DOPPLER
@ DOPPLER
Doppler tracking information subtable.
Definition MSMainEnums.h:288
casacore::MSMainEnums::POINTING
@ POINTING
Pointing information subtable.
Definition MSMainEnums.h:272
casacore::MSMainEnums::WEATHER
@ WEATHER
Weather subtable.
Definition MSMainEnums.h:305
casacore::MSMainEnums::FIELD
@ FIELD
Field subtable.
Definition MSMainEnums.h:261
casacore::MSMainEnums::FREQ_OFFSET
@ FREQ_OFFSET
Frequency offset information subtable.
Definition MSMainEnums.h:290
casacore::MSMainEnums::CAL_TABLES
@ CAL_TABLES
Calibration tables associated with this MS.
Definition MSMainEnums.h:286
casacore::MSMainEnums::DATA_DESCRIPTION
@ DATA_DESCRIPTION
Data Description subtable.
Definition MSMainEnums.h:257
casacore::MSMainEnums::STATE
@ STATE
State subtable.
Definition MSMainEnums.h:280
casacore::MSMainEnums::SORT_COLUMNS
@ SORT_COLUMNS
Listing of sort columns for each sorted table.
Definition MSMainEnums.h:293
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28