/
mainpage.dox
243 lines (239 loc) · 8.94 KB
/
mainpage.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
//# mainpage.dox: doxygen description of Casacore package
//# Copyright (C) 2005
//# 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
//#
//# $Id: mainpage.dox 19988 2007-02-28 10:34:10Z Malte.Marquarding $
namespace casacore {
///
/// \mainpage casacore
///
/// The <a href="http://github.com/casacore/casacore">casacore</a> package
/// contains the core libraries of the old
/// <a href="http://aips2.nrao.edu">AIPS++/CASA</a> package. This split
/// was made to get
/// a better separation of core libraries and applications.
/// <a href="http://casa.nrao.edu">CASA</a> is now built on top of Casacore.
///
/// The system consists of a set of layered libraries (packages) which can
/// be seen best on the <a href="modules.html">Modules page</a>.
/// <br>
/// Included is a library (using Boost-Python) to convert the basic Casacore types
/// (e.g., Array, Record) to and from python. Build of this library is optional.
/// <br>
/// This library is used in the package
/// <a href="https://github.com/casacore/python-casacore">python-casacore</a>
/// (previously pyrap) that offers a
/// high level <a href="http://www.python.org">Python</a> binding to
/// the Casacore functionality.
/// The documentation of the python-casacore packages can be found
/// <a href="http://python-casacore.readthedocs.org/">here</a>.
///
/// The main features of Casacore are:
/// <ul>
/// <li>\ref casa : Core functionality and data types like Array and Record.
/// <li>\ref scimath : N-dim functions with auto-differentiation and linear or non-linear
/// fitting.
/// <li>\ref tables : Table data system supporting N-dim arrays with advanced querying.
/// <li>\ref measures : Values in astronomical reference frames using
/// physical units (<a href="group__Quanta__module.html">Quanta</a>).
/// <li>\ref ms : MeasurementSets for storing data in the UV-domain.
/// <li>\ref images : N-dim images in world coordinates with various analysis operations.
/// </ul>
/// Casacore <a href="../notes/notes.html">notes</a> describe
/// some parts of the system in more detail.
///
/// Casacore consists of the following subpackages:
/// <table border=0>
/// <tr>
/// <td><a href="group__casa.html">casa</a></td>
/// <td>
/// Core modules:
/// N-dim <a href="group__Arrays__module.html">arrays</a>,
/// <a href="group__Quanta__module.html">quanta</a>,
/// <a href="group__OS__module.html">OS</a>,
/// <a href="group__IO__module.html">IO</a>,
/// <a href="group__HDF5__module.html">HDF5</a>,
/// <a href="group__Json__module.html">JSON</a>,
/// <a href="group__Logging__module.html">logging</a>,
/// and various other useful classes.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__scimath.html">scimath</a></td>
/// <td>
/// Mathematical modules
/// N-dim <a href="group__Functionals__module.html">functionals</a>,
/// linear/non-linear
/// <a href="group__Fitting__module.html">fitting</a>,
/// and <a href="group__Mathematics__module.html">miscellaneous</a>.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__tables.html">tables</a></td>
/// <td>
/// Database-like <a href="group__Tables__module.html">tables</a> with advanced
/// query language
/// (<a href="../notes/199.html">TaQL</a>).
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__measures.html">measures</a></td>
/// <td>
/// Quantities with <a href="group__Measures__module.html">references frames</a>
/// and their <a href="group__TableMeasures__module.html">persistency</a>.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__lattices.html">lattices</a></td>
/// <td>
/// Memory- or disk-based N-dim arrays
/// (<a href="group__Lattices__module.html">lattices</a>) with masking,
/// regions, expressions, and math.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__fits.html">fits</a></td>
/// <td>
/// A C++ interface on top of
/// <a href="http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html">cfitsio</a>.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__ms.html">ms</a></td>
/// <td>
/// The data format for visibility data as described in
/// the <a href="../notes/229.html">
/// MeasurementSet definition</a>.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__derivedmscal.html">derivedmscal</a></td>
/// <td>
/// Derived MeasurementSet quantities (like hourangle) that can be
/// used as virtual table columns or as TaQL user defined functions.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__meas.html">meas</a></td>
/// <td>
/// TaQL user defined functions to handle measures. It supports all
/// conversions for epochs, positions, and directions.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__msfits.html">msfits</a></td>
/// <td>
/// Mapping of MeasurementSets to/from FITS.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__coordinates.html">coordinates</a></td>
/// <td>
/// Coordinates for astronomical images.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__images.html">images</a></td>
/// <td>
/// N-dim <a href="group__Images__module.html">images</a> with masks,
/// coordinates, and history.
/// </td>
/// </tr>
/// <tr>
/// <td><a href="group__python.html">python</a></td>
/// <td>
/// N-dim <a href="group__Converters__module.html">python
/// converters</a> for basic Casacore data types.
/// </td>
/// </tr>
/// </table>
///
/// Detailed build instructions are given on the
/// <a href="https://github.com/casacore/casacore/wiki/BuildInstructions">
/// casacore</a> pages. It makes it possible to build selective parts of casacore.
/// <br>When using a specific casacore package, it is useful to know
/// the package dependencies when linking a program. They are as follows:
/// <table border=1>
/// <tr>
/// <td><a href="group__casa.html">casa</a></td>
/// <td></td>
/// </tr>
/// <tr>
/// <td><a href="group__scimath.html">scimath</a></td>
/// <td>casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__tables.html">tables</a></td>
/// <td>casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__measures.html">measures</a></td>
/// <td>tables scimath casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__lattices.html">lattices</a></td>
/// <td>tables scimath casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__fits.html">fits</a></td>
/// <td>measures tables scimath casa cfitsio</td>
/// </tr>
/// <tr>
/// <td><a href="group__ms.html">ms</a></td>
/// <td>measures tables scimath casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__derivedmscal.html">derivedmscal</a></td>
/// <td>measures tables scimath casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__meas.html">meas</a></td>
/// <td>measures tables scimath casa</td>
/// </tr>
/// <tr>
/// <td><a href="group__msfits.html">msfits</a></td>
/// <td>ms fits measures tables scimath casa cfitsio</td>
/// </tr>
/// <tr>
/// <td><a href="group__coordinates.html">coordinates</a></td>
/// <td>fits measures tables scimath casa wcslib cfitsio</td>
/// </tr>
/// <tr>
/// <td><a href="group__images.html">images</a></td>
/// <td>lattices coordinates fits measures tables scimath casa
/// mirlib wcslib cfitsio</td>
/// </tr>
/// <tr>
/// <td><a href="group__python.html">python</a></td>
/// <td>casa boost-python python numpy</td>
/// </tr>
/// </table>
/// <a href="http://www.atnf.csiro.au/computing/software/miriad">mirlib</a>
/// is distributed and built as part of Casacore.
/// <a href="http://www.atnf.csiro.au/~mcalabre/WCS">wcslib</a> and
/// <a href="http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html">cfitsio</a>
/// are external packages that have to be installed before building all of Casacore.
/// <a href="http://www.boost.org/doc/libs/1_57_0/libs/python/doc">Boost-Python</a>
/// is required when building libcasa_python.
}