casacore
Loading...
Searching...
No Matches
LRegions.h
Go to the documentation of this file.
1//# LRegions.h: Regions in a lattice.
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_LREGIONS_H
29#define LATTICES_LREGIONS_H
30
31
32//#include <casacore/lattices/LRegions/LatticeRegion.h>
33//#include <casacore/lattices/LRegions/LCSlicer.h>
34//#include <casacore/lattices/LRegions/LCBox.h>
35//#include <casacore/lattices/LRegions/LCEllipsoid.h>
36//#include <casacore/lattices/LRegions/LCPolygon.h>
37//#include <casacore/lattices/LRegions/LCUnion.h>
38//#include <casacore/lattices/LRegions/LCIntersection.h>
39//#include <casacore/lattices/LRegions/LCDifference.h>
40//#include <casacore/lattices/LRegions/LCConcatenation.h>
41//#include <casacore/lattices/LRegions/LCComplement.h>
42//#include <casacore/lattices/LRegions/LCExtension.h>
43
44namespace casacore { //# NAMESPACE CASACORE - BEGIN
45
46// <module>
47
48// <summary>
49// Regions in a lattice.
50// </summary>
51
52// <prerequisite>
53// <li> module <linkto module=Lattices>Lattices</linkto>
54// </prerequisite>
55
56// <reviewed reviewer="Peter Barnes" date="1999/10/30" demos="">
57// </reviewed>
58
59// <synopsis>
60// There is a rich variety of <linkto class=LCRegion>region</linkto>
61// classes which can be used to define a LatticeRegion in pixel coordinates.
62// The elementary ones are:
63// <ul>
64// <li> <linkto class=LCBox>box</linkto>
65// <li> <linkto class=LCEllipsoid>ellipsoid</linkto>
66// <li> <linkto class=LCPolygon>polygon</linkto>
67// <li> <linkto class=LCPixelSet>pixelset</linkto>
68// <li> <linkto class=LCPagedMask>good/bad mask</linkto>
69// </ul>
70// Compound region classes can be used to make a combination of one or more
71// regions.
72// <ul>
73// <li> <linkto class=LCUnion>union</linkto>
74// <li> <linkto class=LCIntersection>intersection</linkto>
75// <li> <linkto class=LCDifference>difference</linkto>
76// <li> <linkto class=LCConcatenation>concatenation</linkto>
77// <li> <linkto class=LCComplement>complement</linkto>
78// <li> <linkto class=LCExtension>extension</linkto>
79// </ul>
80// Apart from these region classes, class
81// <linkto class=LCSlicer>LCSlicer</linkto> can be used to define
82// a box with optional strides. It also offers the opportunity to
83// define the box in fractions or to define it relative to the
84// center of the lattice or relative to a reference pixel.
85// <br>The final, and most general way, to define regions is by
86// means of the world coordinates region classes in the
87// <linkto module=Images>Images</linkto> module, in particular
88// the <linkto class=WCRegion>WCRegion</linkto> class.
89// However, world coordinate regions can only be used with images.
90// </synopsis>
91
92// </module>
93
94
95} //# NAMESPACE CASACORE - END
96
97#endif
this file contains all the compiler specific defines
Definition mainpage.dox:28