SpectrogramBounds Class Reference

#include <SpectrogramSettings.h>

Inheritance diagram for SpectrogramBounds:

Collaboration diagram for SpectrogramBounds:

Public Member Functions
	~SpectrogramBounds () override
PointerType	Clone () const override
void	GetBounds (const WaveChannel &wc, float &min, float &max) const
void	SetBounds (float min, float max)
Public Member Functions inherited from ClientData::Cloneable< Covariant, Owner >
	Cloneable ()=default
	Cloneable (const Cloneable &)=default
Cloneable &	operator= (const Cloneable &)=default
virtual	~Cloneable ()=default
virtual PointerType	Clone () const =0

Static Public Member Functions
static SpectrogramBounds &	Get (WaveTrack &track)
	Get either the global default settings, or the track's own if previously created. More...
static const SpectrogramBounds &	Get (const WaveTrack &track)
	Get either the global default settings, or the track's own if previously created. More...
static SpectrogramBounds &	Get (WaveChannel &channel)
	Get either the global default settings, or the track's own if previously created. More...
static const SpectrogramBounds &	Get (const WaveChannel &channel)
	Get either the global default settings, or the track's own if previously created. More...

Private Attributes
float	mSpectrumMin = -1
float	mSpectrumMax = -1

Additional Inherited Members
Public Types inherited from ClientData::Cloneable< Covariant, Owner >
using	Base = std::conditional_t< std::is_void_v< Covariant >, Cloneable, Covariant >
using	PointerType = Owner< Base >

Detailed Description

Definition at line 209 of file SpectrogramSettings.h.

Constructor & Destructor Documentation

~SpectrogramBounds()

SpectrogramBounds::~SpectrogramBounds ( )

overridedefault

Member Function Documentation

Clone()

auto SpectrogramBounds::Clone ( ) const

overridevirtual

Implements ClientData::Cloneable< Covariant, Owner >.

Definition at line 722 of file SpectrogramSettings.cpp.

{
   return std::make_unique<SpectrogramBounds>(*this);
}

Get() [1/4]

const SpectrogramBounds & SpectrogramBounds::Get ( const WaveChannel &  channel )

static

Get either the global default settings, or the track's own if previously created.

Definition at line 715 of file SpectrogramSettings.cpp.

{
   return Get(const_cast<WaveChannel&>(channel));
}

References SpectrogramSettings::Get().

Here is the call graph for this function:

Get() [2/4]

const SpectrogramBounds & SpectrogramBounds::Get ( const WaveTrack &  track )

static

Get either the global default settings, or the track's own if previously created.

Definition at line 704 of file SpectrogramSettings.cpp.

{
   return Get(const_cast<WaveTrack&>(track));
}

References SpectrogramSettings::Get().

Here is the call graph for this function:

Get() [3/4]

SpectrogramBounds & SpectrogramBounds::Get ( WaveChannel &  channel )

static

Get either the global default settings, or the track's own if previously created.

Definition at line 710 of file SpectrogramSettings.cpp.

{
   return Get(channel.GetTrack());
}

References SpectrogramSettings::Get(), and WaveChannel::GetTrack().

Here is the call graph for this function:

Get() [4/4]

SpectrogramBounds & SpectrogramBounds::Get ( WaveTrack &  track )

static

Get either the global default settings, or the track's own if previously created.

Definition at line 699 of file SpectrogramSettings.cpp.

{
   return track.Attachments::Get<SpectrogramBounds>(key2);
}

References key2.

Referenced by SpectrumVRulerControls::DoHandleWheelRotation(), SpectrumView::DoSetMinimized(), SpectrumVRulerControls::DoUpdateVRuler(), SpectrumVZoomHandle::DoZoom(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{BrushHandle.cpp}::FrequencyToPosition(), anonymous_namespace{SelectHandle.cpp}::FrequencyToPosition(), anonymous_namespace{BrushHandle.cpp}::PositionToFrequency(), anonymous_namespace{SelectHandle.cpp}::PositionToFrequency(), SpectrumPrefs::Preview(), SpectrumPrefs::Rollback(), and SpectrumPrefs::SpectrumPrefs().

Here is the caller graph for this function:

GetBounds()

void SpectrogramBounds::GetBounds	(	const WaveChannel &	wc,
		float &	min,
		float &	max
	)		const

Definition at line 727 of file SpectrogramSettings.cpp.

{
   auto &wt = wc.GetTrack();
   const double rate = wt.GetRate();
 
   const auto &settings = SpectrogramSettings::Get(wt);
   const auto type = settings.scaleType;
 
   const float top = (rate / 2.);
 
   float bottom;
   if (type == SpectrogramSettings::stLinear)
      bottom = 0.0f;
   else if (type == SpectrogramSettings::stPeriod) {
      // special case
      const auto half = settings.GetFFTLength() / 2;
      // EAC returns no data for below this frequency:
      const float bin2 = rate / half;
      bottom = bin2;
   }
   else
      // logarithmic, etc.
      bottom = 1.0f;
 
   {
      float spectrumMax = mSpectrumMax;
      if (spectrumMax < 0)
         spectrumMax = settings.maxFreq;
      if (spectrumMax < 0)
         max = top;
      else
         max = std::clamp(spectrumMax, bottom, top);
   }
 
   {
      float spectrumMin = mSpectrumMin;
      if (spectrumMin < 0)
         spectrumMin = settings.minFreq;
      if (spectrumMin < 0)
         min = std::max(bottom, top / 1000.0f);
      else
         min = std::clamp(spectrumMin, bottom, top);
   }
}

References SpectrogramSettings::Get(), WaveTrack::GetRate(), WaveChannel::GetTrack(), min(), settings(), SpectrogramSettings::stLinear, and SpectrogramSettings::stPeriod.

Referenced by SpectrumVRulerControls::DoHandleWheelRotation(), SpectrumVRulerControls::DoUpdateVRuler(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{BrushHandle.cpp}::FrequencyToPosition(), anonymous_namespace{SelectHandle.cpp}::FrequencyToPosition(), anonymous_namespace{SelectHandle.cpp}::PositionToFrequency(), and SpectrumPrefs::SpectrumPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBounds()

void SpectrogramBounds::SetBounds ( float  min, float  max  )

inline

Definition at line 231 of file SpectrogramSettings.h.

   { mSpectrumMin = min, mSpectrumMax = max; }

References min().

Referenced by SpectrumVRulerControls::DoHandleWheelRotation(), SpectrumView::DoSetMinimized(), SpectrumPrefs::Preview(), and SpectrumPrefs::Rollback().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mSpectrumMax

float SpectrogramBounds::mSpectrumMax = -1

private

Definition at line 235 of file SpectrogramSettings.h.

mSpectrumMin

float SpectrogramBounds::mSpectrumMin = -1

private

Definition at line 235 of file SpectrogramSettings.h.

---

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

• SpectrogramSettings.h
• SpectrogramSettings.cpp