SpectralData Class Reference

#include <SpectrumView.h>

Collaboration diagram for SpectralData:

Public Member Functions
	SpectralData (double sr)
	SpectralData (const SpectralData &src)=delete
void	CopyFrom (const SpectralData &src)
int	GetHopSize () const
int	GetWindowSize () const
double	GetSR () const
long long	GetStartSample () const
long long	GetEndSample () const
long long	GetCorrectedStartSample () const
long long	GetLength () const
void	addHopBinData (int hopNum, int freqBin)
void	removeHopBinData (int hopNum, int freqBin)
void	clearAllData ()
void	saveAndClearBuffer ()

Public Attributes
HopsAndBinsMap	dataBuffer
std::vector< HopsAndBinsMap >	dataHistory
std::vector< std::pair< int, int > >	coordHistory

Private Attributes
double	mSampleRate
int	mWindowSize
int	mHopSize
long long	mStartSample
long long	mEndSample

Detailed Description

Definition at line 24 of file SpectrumView.h.

Constructor & Destructor Documentation

SpectralData() [1/2]

SpectralData::SpectralData ( double  sr )

inline

Definition at line 33 of file SpectrumView.h.

    :mSampleRate(sr)
    ,mWindowSize( 2048 )
    ,mHopSize ( mWindowSize / 4 )
    // Set start and end in reverse for comparison during data addition
    ,mStartSample(std::numeric_limits<long long>::max())
    ,mEndSample( 0 )
    {}

SpectralData() [2/2]

SpectralData::SpectralData ( const SpectralData &  src )

delete

Member Function Documentation

addHopBinData()

void SpectralData::addHopBinData ( int  hopNum, int  freqBin  )

inline

Definition at line 90 of file SpectrumView.h.

                                              {
      // Update the start and end sampleCount of current selection
      if(hopNum * mHopSize > mEndSample)
         mEndSample = hopNum * mHopSize;
      if(hopNum * mHopSize < mStartSample)
         mStartSample = hopNum * mHopSize;
 
      dataBuffer[hopNum].insert(freqBin);
   }

References dataBuffer, mEndSample, mHopSize, and mStartSample.

clearAllData()

void SpectralData::clearAllData ( )

inline

Definition at line 109 of file SpectrumView.h.

                      {
      // DataBuffer should be clear when the user release cursor
      dataHistory.clear();
      mStartSample = std::numeric_limits<long long>::max();
      mEndSample = 0;
   }

References dataHistory, mEndSample, and mStartSample.

CopyFrom()

void SpectralData::CopyFrom ( const SpectralData &  src )

inline

Definition at line 49 of file SpectrumView.h.

                                         {
      mStartSample = src.GetStartSample();
      mEndSample = src.GetEndSample();
 
      // std containers will perform deepcopy automatically
      dataHistory = src.dataHistory;
      dataBuffer = src.dataBuffer;
      coordHistory = src.coordHistory;
   }

References coordHistory, dataBuffer, dataHistory, GetEndSample(), GetStartSample(), mEndSample, and mStartSample.

Here is the call graph for this function:

GetCorrectedStartSample()

long long SpectralData::GetCorrectedStartSample ( ) const

inline

Definition at line 79 of file SpectrumView.h.

                                             {
      // Correct the start of range so that the first full window is
      // centered at that position
      return std::max<long long>(0, GetStartSample() - 2 * GetHopSize());
   }

References GetHopSize(), and GetStartSample().

Referenced by GetLength().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEndSample()

long long SpectralData::GetEndSample ( ) const

inline

Definition at line 75 of file SpectrumView.h.

                                 {
      return mEndSample;
   }

References mEndSample.

Referenced by CopyFrom(), and GetLength().

Here is the caller graph for this function:

GetHopSize()

int SpectralData::GetHopSize ( ) const

inline

Definition at line 59 of file SpectrumView.h.

                          {
      return mHopSize;
   }

References mHopSize.

Referenced by GetCorrectedStartSample().

Here is the caller graph for this function:

GetLength()

long long SpectralData::GetLength ( ) const

inline

Definition at line 85 of file SpectrumView.h.

                               {
      return GetEndSample() - GetCorrectedStartSample();
   }

References GetCorrectedStartSample(), and GetEndSample().

Here is the call graph for this function:

GetSR()

double SpectralData::GetSR ( ) const

inline

Definition at line 67 of file SpectrumView.h.

                       {
      return mSampleRate;
   }

References mSampleRate.

GetStartSample()

long long SpectralData::GetStartSample ( ) const

inline

Definition at line 71 of file SpectrumView.h.

                                   {
      return mStartSample;
   }

References mStartSample.

Referenced by CopyFrom(), and GetCorrectedStartSample().

Here is the caller graph for this function:

GetWindowSize()

int SpectralData::GetWindowSize ( ) const

inline

Definition at line 63 of file SpectrumView.h.

                            {
      return mWindowSize;
   };

References mWindowSize.

removeHopBinData()

void SpectralData::removeHopBinData ( int  hopNum, int  freqBin  )

inline

Definition at line 100 of file SpectrumView.h.

                                                 {
      // TODO: Recalculate the start and end in case hop falls in 0 || end
      for(auto &dataBuf: dataHistory){
         if(dataBuf.find(hopNum) != dataBuf.end()){
            dataBuf[hopNum].erase(freqBin);
         }
      }
   }

References dataHistory.

saveAndClearBuffer()

void SpectralData::saveAndClearBuffer ( )

inline

Definition at line 116 of file SpectrumView.h.

                            {
      dataHistory.emplace_back(dataBuffer);
      dataBuffer.clear();
      coordHistory.clear();
   }

References coordHistory, dataBuffer, and dataHistory.

Member Data Documentation

coordHistory

std::vector<std::pair<int, int> > SpectralData::coordHistory

Definition at line 46 of file SpectrumView.h.

Referenced by CopyFrom(), and saveAndClearBuffer().

dataBuffer

HopsAndBinsMap SpectralData::dataBuffer

Definition at line 43 of file SpectrumView.h.

Referenced by addHopBinData(), CopyFrom(), and saveAndClearBuffer().

dataHistory

std::vector<HopsAndBinsMap> SpectralData::dataHistory

Definition at line 44 of file SpectrumView.h.

Referenced by clearAllData(), CopyFrom(), removeHopBinData(), saveAndClearBuffer(), and ShouldCaptureEvent().

mEndSample

long long SpectralData::mEndSample

private

Definition at line 30 of file SpectrumView.h.

Referenced by addHopBinData(), clearAllData(), CopyFrom(), and GetEndSample().

mHopSize

int SpectralData::mHopSize

private

Definition at line 28 of file SpectrumView.h.

Referenced by addHopBinData(), and GetHopSize().

mSampleRate

double SpectralData::mSampleRate

private

Definition at line 26 of file SpectrumView.h.

Referenced by GetSR().

mStartSample

long long SpectralData::mStartSample

private

Definition at line 29 of file SpectrumView.h.

Referenced by addHopBinData(), clearAllData(), CopyFrom(), and GetStartSample().

mWindowSize

int SpectralData::mWindowSize

private

Definition at line 27 of file SpectrumView.h.

Referenced by GetWindowSize().

---

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

• SpectrumView.h