source: trunk/doc/source/developer/scantable.rst @ 1852

Last change on this file since 1852 was 1852, checked in by Malte Marquarding, 14 years ago

Added skeleton for and initial text for sphinx-based developer documentation

File size: 2.0 KB
Line 
1=====================
2Scantable Description
3=====================
4
5Introduction
6============
7
8The Scantable is the ASAP single-dish data container. It was designed
9based on the data abstraction of the PKSreader API.
10
11Schema
12======
13
14The Scantable consist of a main (casacore) Table and several sub-tables which
15are referenced via _id_.
16
17----------
18Main Table
19----------
20
21The main table consists of global data (keywords) and row-based data (columns)
22
23Columns
24-------
25
26* **SPECTRA** - *Float(nchannel)*
27
28    the spectral channel data.
29
30* **FLAGTRA** - *uChar(nchannel)*
31
32    the corresponding flags
33
34* **TSYS** - *Float(nchannel)*
35
36    the channel-based system temperature values
37
38* **FLAGROW** - *uInt*
39
40    spectrum based flags
41
42* **TIME** - *MEpoch*
43
44    The mjd time when the observation took place
45
46* **INTERVAL** - *Double*
47
48    the integration time in seconds
49
50* **DIRECTION** - *MDirection*
51
52    the associated direction on the sky
53
54* **AZIMUTH, ELEVATION** - *Float*
55
56    the azimuth/elevation when the spectrum was collected
57
58* **SRCNAME** - *string*
59
60    the name of the source observered
61
62* **SRCTYPE** - *Int*
63
64    the tyep of the source, i.e. indicating if it is an on source scan or
65    off source. This will be used for calibration
66
67* **SCANNO, BEAMNO, POLNO, IFNO, CYCLENO** - *uInt*
68
69    These columns index (0-based) the respective values.
70
71    * SCANNO: the number odf the scan. A scan is usually multiple integrations
72              (cycles)
73
74    * CYCLENO: the integration number within a scan (sub-scan?)
75
76    * IFNO: the index of the IF (spectral window)
77
78    * BEAMNO: the index of the beam (in a multibeam system)
79
80    * POLNO: the index of the polarisation, e.g. XX=0, YY=1, Real(XY)=2,
81             Imag(XY)=3
82
83* **REFBEAMNO** - *Int*
84
85    optional index of the reference beam in a multibeam obervation
86
87* **FREQ_ID, MOLECULE_ID, TCAL_ID, FOCUS_ID, WEATHER_ID, FIT_ID**
88
89
90----------
91Sub-Tables
92----------
93
94FREQUENCY
95---------
96
97blah blah
98
99
100========================
101Mapping to other formats
102========================
103
104MS
105==
Note: See TracBrowser for help on using the repository browser.