casacore
RegionType.h
Go to the documentation of this file.
1//# RegionType.h: Define the various region types in an enum.
2//# Copyright (C) 1998,2002
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$
27
28#ifndef LATTICES_REGIONTYPE_H
29#define LATTICES_REGIONTYPE_H
30
31#include <casacore/casa/aips.h>
32#include <casacore/casa/BasicSL/String.h>
33
34namespace casacore { //# NAMESPACE CASACORE - BEGIN
35
36// <summary>
37// Define the various region types.
38// </summary>
39
40// <use visibility=export>
41
42// <reviewed reviewer="" date="" tests="">
43// </reviewed>
44
45// <synopsis>
46// This class defines 2 enum's used by the region classes in module
47// Lattices and Images.
48// </synopsis>
49
50
52{
53public:
54 // Define the type of region.
55 // The values are used in regionmanager(gui).g, so they should
56 // not be changed.
57 enum Type {
58 // Not used yet.
59 Invalid = -1,
60 // Other type is not used yet.
61 Other = 0,
62 // lattice region (pixel coordinates)
63 LC = 1,
64 // image region (world coordinates)
65 WC = 2,
66 // array slicer (pixel based with optional stride)
68 // Number of recognized types only
70 };
71
72 // Define if a region is absolute or relative.
73 // The values are used in regionmanager(gui).g, so they should
74 // not be changed.
76 // absolute
77 Abs = 1,
78 // relative to reference pixel
79 RelRef = 2,
80 // relative to center
81 RelCen = 3,
82 //# relative to a direction
83//# RelDir = 4,
84 // Number of recognized types only
86 };
87
88 static AbsRelType absRelTypeFromString(const String& absreltype);
89
90
91};
92
93
94
95} //# NAMESPACE CASACORE - END
96
97#endif
AbsRelType
Define if a region is absolute or relative.
Definition: RegionType.h:75
@ nAbsRelTypes
Number of recognized types only.
Definition: RegionType.h:85
@ RelCen
relative to center
Definition: RegionType.h:81
@ RelRef
relative to reference pixel
Definition: RegionType.h:79
static AbsRelType absRelTypeFromString(const String &absreltype)
Type
Define the type of region.
Definition: RegionType.h:57
@ Other
Other type is not used yet.
Definition: RegionType.h:61
@ nRegionTypes
Number of recognized types only.
Definition: RegionType.h:69
@ Invalid
Not used yet.
Definition: RegionType.h:59
@ LC
lattice region (pixel coordinates)
Definition: RegionType.h:63
@ WC
image region (world coordinates)
Definition: RegionType.h:65
@ ArrSlicer
array slicer (pixel based with optional stride)
Definition: RegionType.h:67
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
Functor to apply abs.
Definition: Functors.h:451