vtkTableFFT.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2009 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-NVIDIA-USGov

 
#ifndef vtkTableFFT_h
#define vtkTableFFT_h
 
#include "vtkFFT.h"                  // For vtkFFT::Scaling
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkSmartPointer.h"         // For internal method.
#include "vtkTableAlgorithm.h"
 
#include <memory> // For unique_ptr
 
VTK_ABI_NAMESPACE_BEGIN
 
class VTKFILTERSGENERAL_EXPORT vtkTableFFT : public vtkTableAlgorithm
{
public:
  vtkTypeMacro(vtkTableFFT, vtkTableAlgorithm);
  static vtkTableFFT* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetMacro(CreateFrequencyColumn, bool);
  vtkSetMacro(CreateFrequencyColumn, bool);
  vtkBooleanMacro(CreateFrequencyColumn, bool);


  vtkGetMacro(DefaultSampleRate, double);
  vtkSetMacro(DefaultSampleRate, double);

  enum : int
  {
    HANNING = 0,
    BARTLETT,
    SINE,
    BLACKMAN,
    RECTANGULAR,
 
    MAX_WINDOWING_FUNCTION
  };


  vtkGetMacro(WindowingFunction, int);
  virtual void SetWindowingFunction(int);


  vtkGetMacro(ReturnOnesided, bool);
  vtkSetMacro(ReturnOnesided, bool);
  vtkBooleanMacro(ReturnOnesided, bool);


  vtkGetMacro(AverageFft, bool);
  virtual void SetAverageFft(bool);
  vtkBooleanMacro(AverageFft, bool);


  vtkGetMacro(Normalize, bool);
  vtkSetMacro(Normalize, bool);
  vtkBooleanMacro(Normalize, bool);



  vtkGetMacro(BlockSize, int);
  virtual void SetBlockSize(int);


  vtkGetMacro(BlockOverlap, int);
  vtkSetMacro(BlockOverlap, int);


  vtkGetMacro(ScalingMethod, int);
  vtkSetClampMacro(ScalingMethod, int, vtkFFT::Scaling::Density, vtkFFT::Scaling::Spectrum);


  vtkGetMacro(Detrend, bool);
  vtkSetMacro(Detrend, bool);
  vtkBooleanMacro(Detrend, bool);


  VTK_DEPRECATED_IN_9_3_0("Function has been renamed GetReturnOnesided")
  virtual bool GetOptimizeForRealInput() { return this->GetReturnOnesided(); }
  VTK_DEPRECATED_IN_9_3_0("Function has been renamed SetReturnOnesided")
  virtual void SetOptimizeForRealInput(bool _arg) { this->SetReturnOnesided(_arg); }
  VTK_DEPRECATED_IN_9_3_0("Function has been renamed ReturnOnesidedOn")
  virtual void OptimizeForRealInputOn() { this->ReturnOnesidedOn(); }
  VTK_DEPRECATED_IN_9_3_0("Function has been renamed ReturnOnesidedOff")
  virtual void OptimizeForRealInputOff() { this->ReturnOnesidedOff(); }


  VTK_DEPRECATED_IN_9_3_0(
    "Block behavior is not controlled using BlockSize and BlockOverlap properties.")
  virtual int GetNumberOfBlock() { return 0; }
  VTK_DEPRECATED_IN_9_3_0(
    "Block behavior is not controlled using BlockSize and BlockOverlap properties.")
  virtual void SetNumberOfBlock(int) {}
 
protected:
  vtkTableFFT();
  ~vtkTableFFT() override;
 
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  void Initialize(vtkTable* input);

  vtkSmartPointer<vtkDataArray> DoFFT(vtkDataArray* input);
 
private:
  vtkTableFFT(const vtkTableFFT&) = delete;
  void operator=(const vtkTableFFT&) = delete;
 
  // Common
  bool CreateFrequencyColumn = false;
  double DefaultSampleRate = 1e4;
  bool ReturnOnesided = false;
  bool AverageFft = false;
  int WindowingFunction = RECTANGULAR;
  // Direct method
  bool Normalize = false;
  // Welch method
  int BlockSize = 1024;
  int BlockOverlap = -1;
  bool Detrend = false;
  int ScalingMethod = 0;
 
  struct vtkInternal;
  std::unique_ptr<vtkInternal> Internals;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkTableFFT_h