casacore
LEL.h
Go to the documentation of this file.
1 //# LEL.h: Lattice expression
2 //# Copyright (C) 1996,1997,1998,1999,2003
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 //# $Id: Lattices.h 21521 2014-12-10 08:06:42Z gervandiepen $
27 
28 #ifndef LATTICES_LEL_H
29 #define LATTICES_LEL_H
30 
31 
32 #include <casacore/lattices/LEL/LatticeExpr.h>
33 
34 
35 namespace casacore { //# NAMESPACE CASACORE - BEGIN
36 
37 // <module>
38 
39 // <summary>
40 // Lattice expressions.
41 // </summary>
42 
43 // <prerequisite>
44 // <li> module <linkto module=Lattices>Lattices</linkto>
45 // </prerequisite>
46 
47 // <reviewed reviewer="Peter Barnes" date="1999/10/30" demos="">
48 // </reviewed>
49 
50 // <etymology>
51 // LEL: Lattice Expression Language.
52 // </etymology>
53 
54 // <synopsis>
55 // A <linkto class=LatticeExpr>LatticeExpr</linkto> represents
56 // a mathematical expression of lattices. All standard operators, regions,
57 // and many, many <linkto class=LatticeExprNode>functions</linkto>
58 // can be used in an expression.
59 // <br> An expression is calculated on-the-fly. Thus only when
60 // the user gets a part of the lattice, is the expression calculated
61 // for that part. Subexpressions resulting in a scalar are calculated
62 // only once, on a get of the first part of the lattice expression.
63 // <br> Note that a lattice expression is not writable, thus using
64 // the put function on such a lattice results in an exception.
65 // <br> <a href="../notes/223.html">Note 223</a>
66 // gives a more detailed
67 // explanation of the capabilities of LEL (Lattice Expression Language).
68 // <p>
69 // If the expression consists of images, the result can also be
70 // treated as an image using class <linkto class=ImageExpr>ImageExpr</linkto>.
71 // With the <src>command</src> function in
72 // <linkto class=ImageExprParse>ImageExprParse</linkto> it is possible
73 // to parse and execute a LEL expression given as as a string.
74 
75 // </module>
76 
77 
78 } //# NAMESPACE CASACORE - END
79 
80 #endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28