1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
|
//# LatticeFFT.h: Definitions for Lattice FFT functions
//# Copyright (C) 1996,1997,1998,2003
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef LATTICES_LATTICEFFT_H
#define LATTICES_LATTICEFFT_H
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/Complex.h>
#include <casacore/casa/Exceptions/Error.h>
#include <casacore/scimath/Mathematics/NumericTraits.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
template <class T> class Vector;
template <class T> class Lattice;
// <summary>Functions for Fourier transforming Lattices</summary>
// <reviewed reviewer="" date="" tests="" demos="">
// </reviewed>
// <prerequisite>
// </prerequisite>
// <etymology>
// </etymology>
// <synopsis>
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </example>
// <motivation>
// </motivation>
// <todo asof="">
// </todo>
class LatticeFFT
{
public:
// 2-D in-place complex->complex FFT. Transforms over the first two
// dimensions and iterates over all the others. The Lattice must have two or
// more dimensions otherwise an AipsError is thrown.
template <class ComplexType> static void cfft2d(
Lattice<ComplexType> & cLattice, const Bool toFrequency=True
);
// N-D in-place complex->complex FFT. Only transform over selected
// dimensions. Iterate over the others. whichAxes must be the same length as
// the number of dimensions in the Lattice otherwise an AipsError is thrown.
template <class ComplexType> static void cfft(Lattice<ComplexType> & cLattice,
const Vector<Bool> & whichAxes, const Bool toFrequency=True);
// Non-folded version
template <class ComplexType> static void cfft0(Lattice<ComplexType> & cLattice,
const Vector<Bool> & whichAxes, const Bool toFrequency=True);
// N-D in-place complex->complex FFT. Transform over all axes.
template <class ComplexType> static void cfft(
Lattice<ComplexType> & cLattice, const Bool toFrequency=True
);
// N-D real->complex FFT. Only one half of the Hermition result is
// returned. Transforms are only done on selected dimensions. The origin of
// the transform is the center of the Lattice ie., [nx/2,ny/2,...] if
// doShift is True. Otherwise it is the first element ie., [0,0,...]
template <class ComplexType> static void rcfft(
Lattice<ComplexType> & out,
const Lattice<typename NumericTraits<ComplexType>::ConjugateType> & in,
const Vector<Bool> & whichAxes, const Bool doShift=True,
Bool doFast=False
);
template <class ComplexType> static void myrcfft(
Lattice<ComplexType> & out,
const Lattice<typename NumericTraits<ComplexType>::ConjugateType> & in,
const Vector<Bool> & whichAxes, const Bool doShift=True
);
// N-D real->complex FFT. Only one half of the Hermition result is
// returned. Transform over all dimensions. The origin of
// the transform is the center of the Lattice ie., [nx/2,ny/2,...] if
// doShift is True. Otherwise it is the first element ie., [0,0,...]
template <class ComplexType> static void rcfft(
Lattice<ComplexType> & out,
const Lattice<typename NumericTraits<ComplexType>::ConjugateType> & in,
const Bool doShift=True, Bool doFast=False
);
template <class ComplexType> static void myrcfft(
Lattice<ComplexType> & out,
const Lattice<typename NumericTraits<ComplexType>::ConjugateType> & in,
const Bool doShift=True
);
// N-D complex->real FFT. Only one half of the Hermition input is
// required. If whichAxis is specified Transforms are only done on selected
// dimensions otherwise they are done on all axes. The origin of the
// transform is the center of the Lattice ie., [nx/2,ny/2,...] if doShift is
// True, otherwise it is the first element ie., [0,0,...]
// These functions will <b>scramble the input Lattice</b> unless the versions
// with const inputs are used. The const input versions are less efficient as
// they create a temporary Lattice and copy the input data into it.
// <group>
template <class ComplexType> static void crfft(
Lattice<typename NumericTraits<ComplexType>::ConjugateType> & out,
Lattice<ComplexType> & in, const Vector<Bool> & whichAxes,
const Bool doShift=True, Bool doFast=False
);
template <class ComplexType> static void crfft(
Lattice<typename NumericTraits<ComplexType>::ConjugateType> & out,
Lattice<ComplexType> & in, const Bool doShift=True, Bool doFast=False
);
template <class ComplexType> static void crfft(
Lattice<typename NumericTraits<ComplexType>::ConjugateType> & out,
const Lattice<ComplexType> & in,
const Bool doShift=True, Bool doFast=False
);
// </group>
};
// implement template specializations to throw exceptions in the relevant cases.
template <> inline void LatticeFFT::cfft2d(Lattice<Float>&, const Bool) {
ThrowCc(
String(__func__) +": This method does not support real-valued lattices"
);
}
template <> inline void LatticeFFT::cfft2d(Lattice<Double>&, const Bool) {
ThrowCc(
String(__func__) + ": This method does not support real-valued lattices"
);
}
template <> inline void LatticeFFT::cfft(
Lattice<Float>&, const Vector<Bool>&, const Bool
) {
ThrowCc(
String(__func__) + ": This method does not support real-valued lattices"
);
}
template <> inline void LatticeFFT::cfft(
Lattice<Double>&, const Vector<Bool>&, const Bool
) {
ThrowCc(
String(__func__) + ": This method does not support real-valued lattices"
);
}
template <> inline void LatticeFFT::rcfft(
Lattice<Float> &, const Lattice<Complex> &, const Vector<Bool> & ,
const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::rcfft(
Lattice<Double> &, const Lattice<DComplex> & , const Vector<Bool> &,
const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::myrcfft(
Lattice<Float> &, const Lattice<Complex> &,
const Vector<Bool> &, const Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::myrcfft(
Lattice<Double> &, const Lattice<DComplex> &,
const Vector<Bool> &, const Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::rcfft(
Lattice<Float> &, const Lattice<Complex> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::rcfft(
Lattice<Double> &, const Lattice<DComplex> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::myrcfft(
Lattice<Float> &, const Lattice<Complex> &, const Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::myrcfft(
Lattice<Double> &, const Lattice<DComplex> &, const Bool
) {
ThrowCc(
String(__func__) + ": This is the real -> complex version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<Complex>&, Lattice<Float> &,
const Vector<Bool> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<DComplex> &, Lattice<Double> &,
const Vector<Bool> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<Complex> &, Lattice<Float> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<DComplex> &, Lattice<Double> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<Complex> &, const Lattice<Float> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
template <> inline void LatticeFFT::crfft(
Lattice<DComplex> &, const Lattice<Double> &, const Bool, Bool
) {
ThrowCc(
String(__func__) + ": This is the complex -> real version, you've "
"called it with the wrong parameters"
);
}
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include "LatticeFFT.tcc"
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|