/usr/include/openturns/FFT.hxx is in libopenturns-dev 1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // -*- C++ -*-
/**
* @file FFT.hxx
* @brief This class is enables to launch an FFT transformation /inverse transformation
* This is the interface class
*
* Copyright (C) 2005-2013 EDF-EADS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* @author schueller
* @date 2012-04-18 17:56:46 +0200 (Wed, 18 Apr 2012)
*/
#ifndef OPENTURNS_FFT_HXX
#define OPENTURNS_FFT_HXX
#include "PersistentObject.hxx"
#include "FFTImplementation.hxx"
#include "TypedInterfaceObject.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class FFT
*/
class FFT
: public TypedInterfaceObject<FFTImplementation>
{
CLASSNAME;
public:
typedef Pointer<FFTImplementation> Implementation;
typedef Collection<NumericalScalar> NumericalScalarCollection;
typedef Collection<NumericalComplex> NumericalComplexCollection;
/** Default onstructor */
FFT();
/** Copy constructors */
FFT(const FFTImplementation & implementation,
const String & name = DefaultName);
/** Constructor from implementation */
FFT(const Implementation & p_implementation,
const String & name = DefaultName);
#ifndef SWIG
/** Constructor from implementation pointer */
FFT(FFTImplementation * p_implementation,
const String & name = DefaultName);
#endif
/** FFT transformation on real
* Given the real sequence X_n, compute the sequence Z_k such that:
* Z_k = \sum_{n=0}^{N-1} X_n\exp(-\frac{2i\pi kn}{N})
*/
NumericalComplexCollection transform(const NumericalScalarCollection & collection) const;
/** FFT transformation on complex
* Given the complex sequence Y_n, compute the sequence Z_k such that:
* Z_k = \sum_{n=0}^{N-1} Y_n\exp(-\frac{2i\pi kn}{N})
*/
NumericalComplexCollection transform(const NumericalComplexCollection & collection) const;
/** FFT transformation on complex - For some FFT implementation, the transformation is applied on a part of the collection */
NumericalComplexCollection transform(const NumericalComplexCollection & collection,
const UnsignedLong first,
const UnsignedLong size) const;
/** FFT transformation on complex - For some FFT implementation, the need is to transform a regular sequence of the collection (between first and last, by step = step)*/
NumericalComplexCollection transform(const NumericalComplexCollection & collection,
const UnsignedLong first,
const UnsignedLong step,
const UnsignedLong last) const;
/** FFT inverse transformation
* Given the complex sequence Z_n, compute the sequence Y_k such that:
* Y_k = \frac{1}{N}\sum_{n=0}^{N-1} Z_n\exp(\frac{2i\pi kn}{N})
*/
NumericalComplexCollection inverseTransform(const NumericalComplexCollection & collection) const;
/** FFT inverse transformation - The transformation is applied on a part of the collection */
NumericalComplexCollection inverseTransform(const NumericalComplexCollection & collection,
const UnsignedLong first,
const UnsignedLong size) const;
/** FFT inverse transformation on a regular sequence of the collection (between first and last, by step = step)*/
NumericalComplexCollection inverseTransform(const NumericalComplexCollection & collection,
const UnsignedLong first,
const UnsignedLong step,
const UnsignedLong last) const;
/** String converter */
String __repr__() const;
/** String converter */
String __str__(const String & offset = "") const;
} ; /* class FFT */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_FFT_HXX */
|