casacore
Loading...
Searching...
No Matches
LELLattCoord.h
Go to the documentation of this file.
1//# LELLattCoord.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: 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_LELLATTCOORD_H
27#define LATTICES_LELLATTCOORD_H
28
29
30//# Includes
31#include <casacore/casa/aips.h>
32#include <casacore/lattices/LEL/LELLattCoordBase.h>
33#include <casacore/casa/BasicSL/String.h>
34
35namespace casacore { //# NAMESPACE CASACORE - BEGIN
36
37//# Forward Declarations
38class LatticeExprNode;
39class LattRegionHolder;
40class IPosition;
41
42
43// <summary>
44// The base letter class for lattice coordinates in LEL.
45// </summary>
46
47// <use visibility=local>
48
49// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
50// </reviewed>
51
52// <prerequisite>
53// <li> <linkto class="Lattice"> Lattice</linkto>
54// <li> <linkto class="LELLattCoordBase"> LELLattCoordBase</linkto>
55// </prerequisite>
56
57// <synopsis>
58// This class is a letter class for the envelope class
59// <linkto class=LELCoordinates>LELCoordinates</linkto>.
60// It acts as the coordinates class for Lattice objects without
61// coordinates (like PagedArray).
62//
63// It does not do anything, but makes it possible that other classes
64// (like <linkto class=LELImageCoord>LELImageCoord</linkto>)
65// implement their own behaviour.
66// </synopsis>
67
68// <motivation>
69// It must be possible to handle image coordinates in a lattice
70// expression.
71// </motivation>
72
73//# <todo asof="1998/01/31">
74//# <li>
75//# </todo>
76
77
79{
80public:
82
83 // A virtual destructor is needed so that it will use the actual
84 // destructor in the derived class.
85 virtual ~LELLattCoord();
86
87 // The class does not have true coordinates.
88 virtual Bool hasCoordinates() const;
89
90 // Create a SubLattice for an expression node.
92 (const LatticeExprNode& expr,
93 const LattRegionHolder& region) const;
94
95 // Create an extension for an expression node.
97 (const LatticeExprNode& expr,
98 const IPosition& newShape,
99 const LELLattCoordBase& newCoord) const;
100
101 // Create a rebinning for an expression node.
103 (const LatticeExprNode& expr,
104 const IPosition& binning) const;
105
106 // Get the coordinates of the spectral axis for the given shape.
107 // This function throws an exception as a Lattice has no coordinates.
108 virtual uInt getSpectralInfo (Vector<Double>& worldCoordinates,
109 const IPosition& shape) const;
110
111 // The name of the class.
112 virtual String classname() const;
113
114 // Check how the coordinates of this and that compare.
115 virtual Int compare (const LELLattCoordBase& other) const;
116
117 // Check how the coordinates of this and that image compare.
118 // This function is used by <src>conform</src> to make a
119 // double virtual dispatch possible.
120 virtual Int doCompare (const LELImageCoord& other) const;
121};
122
123
124
125} //# NAMESPACE CASACORE - END
126
127#endif
128
virtual LatticeExprNode makeRebinLattice(const LatticeExprNode &expr, const IPosition &binning) const
Create a rebinning for an expression node.
virtual ~LELLattCoord()
A virtual destructor is needed so that it will use the actual destructor in the derived class.
virtual String classname() const
The name of the class.
virtual LatticeExprNode makeSubLattice(const LatticeExprNode &expr, const LattRegionHolder &region) const
Create a SubLattice for an expression node.
virtual Bool hasCoordinates() const
The class does not have true coordinates.
virtual Int compare(const LELLattCoordBase &other) const
Check how the coordinates of this and that compare.
virtual LatticeExprNode makeExtendLattice(const LatticeExprNode &expr, const IPosition &newShape, const LELLattCoordBase &newCoord) const
Create an extension for an expression node.
virtual uInt getSpectralInfo(Vector< Double > &worldCoordinates, const IPosition &shape) const
Get the coordinates of the spectral axis for the given shape.
virtual Int doCompare(const LELImageCoord &other) const
Check how the coordinates of this and that image compare.
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
unsigned int uInt
Definition aipstype.h:49
TableExprNode shape(const TableExprNode &array)
Function operating on any scalar or array resulting in a Double array containing the shape.
Definition ExprNode.h:1991
int Int
Definition aipstype.h:48
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40