#include <CQParameters.h>

Public Types

enum  WindowType {
  SqrtBlackmanHarris, SqrtBlackman, SqrtHann, BlackmanHarris,
  Blackman, Hann
}
 
enum  DecimatorType { BetterDecimator, FasterDecimator }
 

Public Member Functions

 CQParameters (double _sampleRate, double _minFrequency, double _maxFrequency, int _binsPerOctave)
 

Public Attributes

double sampleRate
 
double minFrequency
 
double maxFrequency
 
int binsPerOctave
 
double q
 
double atomHopFactor
 
double threshold
 
WindowType window
 
DecimatorType decimator
 

Detailed Description

Common parameters for constructing Constant-Q implementation objects (both forward and inverse transforms).

Member Enumeration Documentation

Enumerator
BetterDecimator 
FasterDecimator 
Enumerator
SqrtBlackmanHarris 
SqrtBlackman 
SqrtHann 
BlackmanHarris 
Blackman 
Hann 

Constructor & Destructor Documentation

CQParameters::CQParameters ( double  _sampleRate,
double  _minFrequency,
double  _maxFrequency,
int  _binsPerOctave 
)
inline

Construct a set of parameters with the given input signal sample rate, frequency range, and number of bins per octave. The remaining parameters will take their usual defaults; if you want to change them, just assign the respective data members after construction.

Member Data Documentation

double CQParameters::atomHopFactor

Hop size between temporal atoms, where 1 == no overlap and smaller values indicate overlapping atoms.

int CQParameters::binsPerOctave

Number of output frequency bins per octave.

DecimatorType CQParameters::decimator

Quality setting for the sample rate decimator.

double CQParameters::maxFrequency

Maximum frequency to include in Constant-Q output.

double CQParameters::minFrequency

Minimum frequency desired to include in Constant-Q output. The actual minimum will normally be calculated as a round number of octaves below the maximum frequency, and may differ from this.

double CQParameters::q

Spectral atom bandwidth scaling factor. q == 1 is optimal for reconstruction, q < 1 increases redundancy (smearing) in the frequency domain but improves time resolution.

double CQParameters::sampleRate

Sampling rate of input signal.

double CQParameters::threshold

Sparsity threshold for Constant-Q kernel: values with magnitude smaller than this are truncated to zero.

WindowType CQParameters::window

Window shape to use for the Constant-Q kernel atoms.


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