Entropy Piano Tuner  1.1.3 (documentation not yet complete)
An open-source experimental software for piano tuning by entropy minimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FFTData Struct Reference

Data struct for a FFT. More...

#include <fftadapter.h>

Public Member Functions

bool isValid ()
 Function to validate the fft data. More...
 
double getTime ()
 Function to get the time of the signal in seconds. More...
 

Public Attributes

FFTWVector fft
 The actual fft. More...
 
int samplingRate = -1
 The sampling rate of the fft. More...
 

Detailed Description

Data struct for a FFT.

A fourier transform is always defined by its data and the sampling rate. The first argument its the FFTPointer the second one the sampling rate. Invalid or unset states have a invalid FFTPointer or a negative sampling rate.

Definition at line 55 of file fftadapter.h.

Member Function Documentation

double FFTData::getTime ( )
inline

Function to get the time of the signal in seconds.

Returns
2 * fft.size() / samplingRate

Definition at line 75 of file fftadapter.h.

bool FFTData::isValid ( )
inline

Function to validate the fft data.

Returns
It the FFTData valide.

This will check if the fft size is greater zero and if the sampling rate is greater zero.

Definition at line 66 of file fftadapter.h.

Member Data Documentation

FFTWVector FFTData::fft

The actual fft.

Definition at line 56 of file fftadapter.h.

int FFTData::samplingRate = -1

The sampling rate of the fft.

Definition at line 57 of file fftadapter.h.


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