Audacity  2.2.0
SpectrogramSettings Class Reference

Spectrogram settings, either for one track or as defaults. More...

#include <SpectrogramSettings.h>

Classes

class  Globals
 

Public Types

enum  { LogMinWindowSize = 3, LogMaxWindowSize = 15, NumWindowSizes = LogMaxWindowSize - LogMinWindowSize + 1 }
 
enum  ScaleType {
  stLinear, stLogarithmic, stMel, stBark,
  stErb, stPeriod, stNumScaleTypes
}
 
enum  Algorithm { algSTFT = 0, algReassignment, algPitchEAC, algNumAlgorithms }
 

Public Member Functions

 SpectrogramSettings ()
 
 SpectrogramSettings (const SpectrogramSettings &other)
 
SpectrogramSettingsoperator= (const SpectrogramSettings &other)
 
 ~SpectrogramSettings ()
 
bool IsDefault () const
 
bool Validate (bool quiet)
 
void LoadPrefs ()
 
void SavePrefs ()
 
void InvalidateCaches ()
 
void DestroyWindows ()
 
void CacheWindows () const
 
void ConvertToEnumeratedWindowSizes ()
 
void ConvertToActualWindowSizes ()
 
float findBin (float frequency, float binUnit) const
 
NumberScale GetScale (float minFreq, float maxFreq) const
 
bool SpectralSelectionEnabled () const
 
size_t WindowSize () const
 
size_t ZeroPaddingFactor () const
 
size_t GetFFTLength () const
 
size_t NBins () const
 

Static Public Member Functions

static const wxArrayString & GetScaleNames ()
 
static const wxArrayString & GetAlgorithmNames ()
 
static SpectrogramSettingsdefaults ()
 

Public Attributes

int minFreq
 
int maxFreq
 
int range
 
int gain
 
int frequencyGain
 
int windowType
 
bool isGrayscale
 
ScaleType scaleType
 
bool spectralSelection
 
Algorithm algorithm
 
HFFT hFFT
 
Floats window
 
Floats tWindow
 
Floats dWindow
 

Private Attributes

int windowSize
 
int zeroPaddingFactor
 

Friends

class SpectrumPrefs
 

Detailed Description

Spectrogram settings, either for one track or as defaults.

Member Enumeration Documentation

anonymous enum
Enumerator
LogMinWindowSize 
LogMaxWindowSize 
NumWindowSizes 
Enumerator
algSTFT 
algReassignment 
algPitchEAC 
algNumAlgorithms 
Enumerator
stLinear 
stLogarithmic 
stMel 
stBark 
stErb 
stPeriod 
stNumScaleTypes 

Constructor & Destructor Documentation

SpectrogramSettings::SpectrogramSettings ( )

References LoadPrefs().

SpectrogramSettings::SpectrogramSettings ( const SpectrogramSettings other)
SpectrogramSettings::~SpectrogramSettings ( )

References DestroyWindows().

Member Function Documentation

void SpectrogramSettings::CacheWindows ( ) const
void SpectrogramSettings::ConvertToActualWindowSizes ( )
void SpectrogramSettings::DestroyWindows ( )
float SpectrogramSettings::findBin ( float  frequency,
float  binUnit 
) const
const wxArrayString & SpectrogramSettings::GetAlgorithmNames ( )
static

References _().

Referenced by SpectrumPrefs::Populate().

const wxArrayString & SpectrogramSettings::GetScaleNames ( )
static

References _().

Referenced by BEGIN_POPUP_MENU(), and SpectrumPrefs::Populate().

void SpectrogramSettings::InvalidateCaches ( )

References DestroyWindows().

Referenced by LoadPrefs().

bool SpectrogramSettings::IsDefault ( ) const
inline

References defaults().

bool SpectrogramSettings::SpectralSelectionEnabled ( ) const
size_t SpectrogramSettings::ZeroPaddingFactor ( ) const
inline

Friends And Related Function Documentation

friend class SpectrumPrefs
friend

Member Data Documentation

Floats SpectrogramSettings::dWindow
mutable
HFFT SpectrogramSettings::hFFT
mutable
bool SpectrogramSettings::isGrayscale
Floats SpectrogramSettings::tWindow
mutable
Floats SpectrogramSettings::window
mutable
int SpectrogramSettings::windowSize
private

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