00001 //# LRegions.h: Regions in a lattice. 00002 //# Copyright (C) 1996,1997,1998,1999,2003 00003 //# Associated Universities, Inc. Washington DC, USA. 00004 //# 00005 //# This library is free software; you can redistribute it and/or modify it 00006 //# under the terms of the GNU Library General Public License as published by 00007 //# the Free Software Foundation; either version 2 of the License, or (at your 00008 //# option) any later version. 00009 //# 00010 //# This library is distributed in the hope that it will be useful, but WITHOUT 00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00012 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public 00013 //# License for more details. 00014 //# 00015 //# You should have received a copy of the GNU Library General Public License 00016 //# along with this library; if not, write to the Free Software Foundation, 00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA. 00018 //# 00019 //# Correspondence concerning AIPS++ should be addressed as follows: 00020 //# Internet email: aips2-request@nrao.edu. 00021 //# Postal address: AIPS++ Project Office 00022 //# National Radio Astronomy Observatory 00023 //# 520 Edgemont Road 00024 //# Charlottesville, VA 22903-2475 USA 00025 //# 00026 //# $Id: Lattices.h 21521 2014-12-10 08:06:42Z gervandiepen $ 00027 00028 #ifndef LATTICES_LREGIONS_H 00029 #define LATTICES_LREGIONS_H 00030 00031 00032 //#include <casacore/lattices/LRegions/LatticeRegion.h> 00033 //#include <casacore/lattices/LRegions/LCSlicer.h> 00034 //#include <casacore/lattices/LRegions/LCBox.h> 00035 //#include <casacore/lattices/LRegions/LCEllipsoid.h> 00036 //#include <casacore/lattices/LRegions/LCPolygon.h> 00037 //#include <casacore/lattices/LRegions/LCUnion.h> 00038 //#include <casacore/lattices/LRegions/LCIntersection.h> 00039 //#include <casacore/lattices/LRegions/LCDifference.h> 00040 //#include <casacore/lattices/LRegions/LCConcatenation.h> 00041 //#include <casacore/lattices/LRegions/LCComplement.h> 00042 //#include <casacore/lattices/LRegions/LCExtension.h> 00043 00044 namespace casacore { //# NAMESPACE CASACORE - BEGIN 00045 00046 // <module> 00047 00048 // <summary> 00049 // Regions in a lattice. 00050 // </summary> 00051 00052 // <prerequisite> 00053 // <li> module <linkto module=Lattices>Lattices</linkto> 00054 // </prerequisite> 00055 00056 // <reviewed reviewer="Peter Barnes" date="1999/10/30" demos=""> 00057 // </reviewed> 00058 00059 // <synopsis> 00060 // There is a rich variety of <linkto class=LCRegion>region</linkto> 00061 // classes which can be used to define a LatticeRegion in pixel coordinates. 00062 // The elementary ones are: 00063 // <ul> 00064 // <li> <linkto class=LCBox>box</linkto> 00065 // <li> <linkto class=LCEllipsoid>ellipsoid</linkto> 00066 // <li> <linkto class=LCPolygon>polygon</linkto> 00067 // <li> <linkto class=LCPixelSet>pixelset</linkto> 00068 // <li> <linkto class=LCPagedMask>good/bad mask</linkto> 00069 // </ul> 00070 // Compound region classes can be used to make a combination of one or more 00071 // regions. 00072 // <ul> 00073 // <li> <linkto class=LCUnion>union</linkto> 00074 // <li> <linkto class=LCIntersection>intersection</linkto> 00075 // <li> <linkto class=LCDifference>difference</linkto> 00076 // <li> <linkto class=LCConcatenation>concatenation</linkto> 00077 // <li> <linkto class=LCComplement>complement</linkto> 00078 // <li> <linkto class=LCExtension>extension</linkto> 00079 // </ul> 00080 // Apart from these region classes, class 00081 // <linkto class=LCSlicer>LCSlicer</linkto> can be used to define 00082 // a box with optional strides. It also offers the opportunity to 00083 // define the box in fractions or to define it relative to the 00084 // center of the lattice or relative to a reference pixel. 00085 // <br>The final, and most general way, to define regions is by 00086 // means of the world coordinates region classes in the 00087 // <linkto module=Images>Images</linkto> module, in particular 00088 // the <linkto class=WCRegion>WCRegion</linkto> class. 00089 // However, world coordinate regions can only be used with images. 00090 // </synopsis> 00091 00092 // </module> 00093 00094 00095 } //# NAMESPACE CASACORE - END 00096 00097 #endif