Changeset 467 in Sophya for trunk/SophyaLib/NTools/fftserver.h

Timestamp:

Oct 15, 1999, 2:05:15 PM (26 years ago)

Author:

ansari

Message:

Fixing of bugs, output formats, inverse transforms.

File:

• trunk/SophyaLib/NTools/fftserver.h (modified) (1 diff)

trunk/SophyaLib/NTools/fftserver.h

@@ -39 +39 @@
 };
 #endif
+
+/*! \class FFTServer
+ \brief An FFT server
+
+A class that calculates Fourier transforms forwards and backwards.
+
+The class calls the c library ``fftpack'', which is accessible and documented
+at http://www.netlib.org/fftpack/.  However, the class functions do not
+necessarily correspond with the equivalent fftpack function.  For example,
+fftpack "forward" transformations are in fact inverse fourier transformations.
+Otherwise, the output is in the fftpack format.
+
+Complex input must be entered using the <complex> template.  Otherwise,
+all input is assumed to be real.
+
+Due to the way that fftpack manages
+its work arrays, an object can run faster if the length of the input arrays
+does not change.  For example, if you need to do a series of FFT's
+of differing length, it may be more efficient to create an fftserver object
+for each length.
+*/
+
+/*! \fn virtual void FFTServer::fftf(int l, float* inout)
+  \param l length of array
+  \param inout input array /output forward FFT (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftb(int l, float* inout)
+  \param l length of array
+  \param inout input array /output backward FFT (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftf(int l, double* inout)
+  \param l length of array
+  \param inout input array /output forward FFT (original array destroyed)
+  \param inout input/output array (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftb(int l, double* inout)
+  \param l length of array
+  \param inout input array /output backward FFT(original array destroyed)
+*/
+/*!\fn  virtual void FFTServer::fftf(int l, complex<float>* inout)
+  \param l length of array
+  \param inout input array /output forward FFT (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftb(int l, complex<float>* inout)
+  \param l length of array
+  \param inout input array /output backward FFT (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftf(int l, complex<double>* inout)
+  \param l length of array
+  \param inout input array /output forward FFT (original array destroyed)
+*/
+/*! \fn virtual void FFTServer::fftb(int l, complex<double>* inout)
+  \param l length of array
+  \param inout input array /output backward FFT(original array destroyed)
+*/
+/*!\fn  virtual void FFTServer::fftf(Vector& in, Vector& out)
+  \param in input array
+  \param out forward FFT
+*/
+/*! \fn virtual void FFTServer::fftb(Vector& in, Vector& out)
+  \param in input array
+  \param out backward FFT
+*/