GPLIB++
Public Member Functions | List of all members
gplib::TsSpectrum Class Reference

The class CTsSpectrum is used to calculate spectra from (real) time series data. More...

#include <TsSpectrum.h>

Public Member Functions

 TsSpectrum (bool WantMultiCalc=false)
 The constructor is explicit to prohibit conversion from bool. More...
 
virtual ~TsSpectrum ()
 
template<typename _InputIterator , typename _OutputIterator >
void CalcSpectrum (_InputIterator tsbegin, _InputIterator tsend, _OutputIterator freqbegin, _OutputIterator freqend)
 The member function to calculate a spectrum from a time series. More...
 
template<typename _InputIterator , typename _OutputIterator >
void CalcTimeSeries (_InputIterator freqbegin, _InputIterator freqend, _OutputIterator tsbegin, _OutputIterator tsend)
 The member function to calculate a time series from (complex) spectra. More...
 

Detailed Description

The class CTsSpectrum is used to calculate spectra from (real) time series data.

CTsSpectrum is basically a wrapper for the fftw3 functionality for real data it manages both the plans and the local data needed by fftw3. This class is not thread-safe. DO NOT use it within an openmp parallelized loop or any kind of threaded program.

Definition at line 21 of file TsSpectrum.h.

Constructor & Destructor Documentation

gplib::TsSpectrum::TsSpectrum ( bool  WantMultiCalc = false)
explicit

The constructor is explicit to prohibit conversion from bool.

The construtor takes an optional boolean value as an argument, that determines whether we want to use fftw's multiple calculation This makes only sense if we do a lot of calculations in the same direction and with the same length

Definition at line 9 of file TsSpectrum.cpp.

gplib::TsSpectrum::~TsSpectrum ( )
virtual

Definition at line 34 of file TsSpectrum.cpp.


The documentation for this class was generated from the following files: