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