casacore
Loading...
Searching...
No Matches
LELLattCoordBase.h
Go to the documentation of this file.
1//# LELLattCoordBase.h: The base letter class for lattice coordinates in LEL
2//# Copyright (C) 1998,1999,2000,2001
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_LELLATTCOORDBASE_H
29#define LATTICES_LELLATTCOORDBASE_H
30
31
32//# Includes
33#include <casacore/casa/aips.h>
34#include <casacore/casa/Arrays/ArrayFwd.h>
35#include <casacore/casa/BasicSL/String.h>
36
37namespace casacore { //# NAMESPACE CASACORE - BEGIN
38
39//# Forward Declarations
40class LELImageCoord;
41class IPosition;
42
43// <summary>
44// The base letter class for lattice coordinates in LEL.
45// </summary>
46
47// <use visibility=local>
48
49// <reviewed reviewer="Bob Garwood" date="2000/01/25" tests="tLatticeExpr">
50// </reviewed>
51
52// <prerequisite>
53// <li> <linkto class="Lattice"> Lattice</linkto>
54// <li> <linkto class="LELCoordinates"> LELCoordinates</linkto>
55// </prerequisite>
56
57// <synopsis>
58// This abstract base class is the basic letter for the envelope class
59// <linkto class=LELCoordinates>LELCoordinates</linkto>.
60// It does not do anything, but makes it possible that derived classes
61// (like <linkto class=LELLattCoord>LELLattCoord</linkto> and
62// <linkto class=LELImageCoord>LELImageCoord</linkto>)
63// implement their own behaviour.
64// </synopsis>
65
66// <motivation>
67// It must be possible to handle image coordinates in a lattice
68// expression.
69// </motivation>
70
71//# <todo asof="1998/01/31">
72//# <li>
73//# </todo>
74
75
77{
78public:
81
82 // A virtual destructor is needed so that it will use the actual
83 // destructor in the derived class.
85
86 // Does the class have true coordinates?
87 virtual Bool hasCoordinates() const = 0;
88
89 // The name of the class.
90 virtual String classname() const = 0;
91
92 // Get the coordinates of the spectral axis for the given shape.
93 // It returns the pixel axis number of the spectral coordinates.
94 // -1 indicates that there is no pixel spectral axis.
95 // An exception is thrown if there are no world spectral coordinates.
96 virtual uInt getSpectralInfo (Vector<Double>& worldCoordinates,
97 const IPosition& shape) const = 0;
98
99 // Check how the coordinates of this and that compare.
100 virtual Int compare (const LELLattCoordBase& other) const = 0;
101
102 // Check how the coordinates of this and that image compare.
103 // This function is used by <src>conform</src> to make a
104 // double virtual dispatch possible.
105 virtual Int doCompare (const LELImageCoord& other) const = 0;
106};
107
108
109
110} //# NAMESPACE CASACORE - END
111
112#endif
113
virtual Int doCompare(const LELImageCoord &other) const =0
Check how the coordinates of this and that image compare.
virtual Int compare(const LELLattCoordBase &other) const =0
Check how the coordinates of this and that compare.
virtual uInt getSpectralInfo(Vector< Double > &worldCoordinates, const IPosition &shape) const =0
Get the coordinates of the spectral axis for the given shape.
virtual Bool hasCoordinates() const =0
Does the class have true coordinates?
virtual String classname() const =0
The name of the class.
virtual ~LELLattCoordBase()
A virtual destructor is needed so that it will use the actual destructor in the derived class.
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
unsigned int uInt
Definition aipstype.h:51
TableExprNode shape(const TableExprNode &array)
Function operating on any scalar or array resulting in a Double array containing the shape.
Definition ExprNode.h:1987
int Int
Definition aipstype.h:50
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:42