VTK  9.0.20210926
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkFFT Class Reference

perform Discrete Fourier Transforms More...

#include <vtkFFT.h>

Inheritance diagram for vtkFFT:
[legend]
Collaboration diagram for vtkFFT:
[legend]

Public Types

using ScalarNumber = kiss_fft_scalar
 
using ComplexNumber = kiss_fft_cpx
 
typedef vtkObject Superclass
 
using WindowGenerator = double(*)(const std::size_t, const std::size_t)
 Window generator functions. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFFTNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkFFTNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFFTSafeDownCast (vtkObjectBase *o)
 
static std::vector< ComplexNumberFft (const std::vector< ComplexNumber > &in)
 Compute the one-dimensional DFT for complex input. More...
 
static std::vector< ComplexNumberFft (const std::vector< ScalarNumber > &in)
 
static std::vector< ComplexNumberRFft (const std::vector< ScalarNumber > &in)
 Compute the one-dimensional DFT for real input. More...
 
static std::vector< ComplexNumberIFft (const std::vector< ComplexNumber > &in)
 Compute the inverse of Fft. More...
 
static std::vector< ScalarNumberIRFft (const std::vector< ComplexNumber > &in)
 Compute the inverse of RFft. More...
 
static double Abs (const ComplexNumber &in)
 Return the absolute value (also known as norm, modulus, or magnitude) of complex number. More...
 
static double SquaredAbs (const ComplexNumber &in)
 Return the squared absolute value of the complex number. More...
 
static std::vector< double > FftFreq (int windowLength, double sampleSpacing)
 Return the DFT sample frequencies. More...
 
static std::vector< double > RFftFreq (int windowLength, double sampleSpacing)
 Return the DFT sample frequencies for the real version of the dft (see Rfft). More...
 
static double HanningGenerator (const std::size_t x, const std::size_t size)
 
static double BartlettGenerator (const std::size_t x, const std::size_t size)
 
static double SineGenerator (const std::size_t x, const std::size_t size)
 
static double BlackmanGenerator (const std::size_t x, const std::size_t size)
 
static double RectangularGenerator (const std::size_t x, const std::size_t size)
 
template<typename Array1D >
static void GenerateKernel1D (Array1D *kernel, const std::size_t n, WindowGenerator generator)
 Given a window generator function, create a symmetric 1D kernel. More...
 
template<typename Array2D >
static void GenerateKernel2D (Array2D *kernel, const std::size_t n, const std::size_t m, WindowGenerator generator)
 Given a window generator function, create a symmetric 2D kernel. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFFT ()=default
 
 ~vtkFFT () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

perform Discrete Fourier Transforms

vtkFFT provides methods to perform Discrete Fourier Transforms (DFT). These include providing forward and reverse Fourier transforms. The current implementation uses the third-party library kissfft.

The terminology tries to follow the Numpy terminology, that is :

Definition at line 45 of file vtkFFT.h.

Member Typedef Documentation

◆ ScalarNumber

using vtkFFT::ScalarNumber = kiss_fft_scalar

Definition at line 48 of file vtkFFT.h.

◆ ComplexNumber

using vtkFFT::ComplexNumber = kiss_fft_cpx

Definition at line 49 of file vtkFFT.h.

◆ Superclass

Definition at line 52 of file vtkFFT.h.

◆ WindowGenerator

using vtkFFT::WindowGenerator = double (*)(const std::size_t, const std::size_t)

Window generator functions.

Implementation only needs to be valid for x E [0; size / 2] because kernels are symmetric by definitions. This point is very important for some kernels like Bartlett for example.

Warning
Hanning and Bartlett generators needs a size > 1 !

Can be used with GenerateKernel1D and GenerateKernel2D for generating full kernels.

Definition at line 128 of file vtkFFT.h.

Constructor & Destructor Documentation

◆ vtkFFT()

vtkFFT::vtkFFT ( )
protecteddefault

◆ ~vtkFFT()

vtkFFT::~vtkFFT ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkFFT* vtkFFT::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkFFT::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkFFT::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkFFT* vtkFFT::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFFT::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkFFT* vtkFFT::NewInstance ( ) const

◆ PrintSelf()

void vtkFFT::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ Fft() [1/2]

static std::vector<ComplexNumber> vtkFFT::Fft ( const std::vector< ComplexNumber > &  in)
static

Compute the one-dimensional DFT for complex input.

If input is scalars then the imaginary part is set to 0

input has n complex points output has n complex points in case of success and empty in case of failure

◆ Fft() [2/2]

static std::vector<ComplexNumber> vtkFFT::Fft ( const std::vector< ScalarNumber > &  in)
static

◆ RFft()

static std::vector<ComplexNumber> vtkFFT::RFft ( const std::vector< ScalarNumber > &  in)
static

Compute the one-dimensional DFT for real input.

input has n scalar points output has (n/2) + 1 complex points in case of success and empty in case of failure

◆ IFft()

static std::vector<ComplexNumber> vtkFFT::IFft ( const std::vector< ComplexNumber > &  in)
static

Compute the inverse of Fft.

The input should be ordered in the same way as is returned by Fft, i.e.,

  • in[0] should contain the zero frequency term,
  • in[1:n//2] should contain the positive-frequency terms,
  • in[n//2 + 1:] should contain the negative-frequency terms.

input has n complex points output has n scalar points in case of success and empty in case of failure

◆ IRFft()

static std::vector<ScalarNumber> vtkFFT::IRFft ( const std::vector< ComplexNumber > &  in)
static

Compute the inverse of RFft.

The input is expected to be in the form returned by Rfft, i.e. the real zero-frequency term followed by the complex positive frequency terms in order of increasing frequency.

input has (n/2) + 1 complex points output has n scalar points in case of success and empty in case of failure

◆ Abs()

double vtkFFT::Abs ( const ComplexNumber in)
inlinestatic

Return the absolute value (also known as norm, modulus, or magnitude) of complex number.

Definition at line 162 of file vtkFFT.h.

◆ SquaredAbs()

double vtkFFT::SquaredAbs ( const ComplexNumber in)
inlinestatic

Return the squared absolute value of the complex number.

Definition at line 168 of file vtkFFT.h.

◆ FftFreq()

static std::vector<double> vtkFFT::FftFreq ( int  windowLength,
double  sampleSpacing 
)
static

Return the DFT sample frequencies.

Output has windowLength size.

◆ RFftFreq()

static std::vector<double> vtkFFT::RFftFreq ( int  windowLength,
double  sampleSpacing 
)
static

Return the DFT sample frequencies for the real version of the dft (see Rfft).

Output has (windowLength / 2) + 1 size.

◆ HanningGenerator()

double vtkFFT::HanningGenerator ( const std::size_t  x,
const std::size_t  size 
)
inlinestatic

Definition at line 174 of file vtkFFT.h.

◆ BartlettGenerator()

double vtkFFT::BartlettGenerator ( const std::size_t  x,
const std::size_t  size 
)
inlinestatic

Definition at line 180 of file vtkFFT.h.

◆ SineGenerator()

double vtkFFT::SineGenerator ( const std::size_t  x,
const std::size_t  size 
)
inlinestatic

Definition at line 186 of file vtkFFT.h.

◆ BlackmanGenerator()

double vtkFFT::BlackmanGenerator ( const std::size_t  x,
const std::size_t  size 
)
inlinestatic

Definition at line 192 of file vtkFFT.h.

◆ RectangularGenerator()

double vtkFFT::RectangularGenerator ( const std::size_t  x,
const std::size_t  size 
)
inlinestatic

Definition at line 199 of file vtkFFT.h.

◆ GenerateKernel1D()

template<typename Array1D >
void vtkFFT::GenerateKernel1D ( Array1D *  kernel,
const std::size_t  n,
WindowGenerator  generator 
)
static

Given a window generator function, create a symmetric 1D kernel.

kernel is the pointer to the raw data array

Definition at line 206 of file vtkFFT.h.

◆ GenerateKernel2D()

template<typename Array2D >
void vtkFFT::GenerateKernel2D ( Array2D *  kernel,
const std::size_t  n,
const std::size_t  m,
WindowGenerator  generator 
)
static

Given a window generator function, create a symmetric 2D kernel.

kernel is the pointer to the raw 2D data array.

Definition at line 217 of file vtkFFT.h.


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