AnalysisContext< SampleType > Class Template Reference

Contains audio-related artefacts useful for analysis by matchers. More...

#include <hart_analysis_context.hpp>

Public Member Functions
	AnalysisContext (const AudioBuffer< SampleType > &inputAudio, const AudioBuffer< SampleType > &outputAudio)
	Creates an instance of analysis context.
const AudioBuffer< SampleType > &	inputAudio () const
	Returns a buffer with input audio.
const AudioBuffer< SampleType > &	outputAudio () const
	Returns a buffer with output audio.
const Spectrum &	inputSpectrum () const
	Returns a spectrum of the input audio.
const Spectrum &	outputSpectrum () const
	Returns a spectrum of the output audio.

Detailed Description

template<typename SampleType>
class hart::AnalysisContext< SampleType >

Contains audio-related artefacts useful for analysis by matchers.

Designed to be used to retreive various audio-related artefacts for audio analysis, such as input and output audio buffers, spectra, and possibly some others.

All derivative artefacts, such as Spectra, are calculated on demand and then cached. Everything is read only.

Designed as a lightweight object, so it's totally okay to copy it.

Template Parameters

Type	of samples of the audio buffers, typicalle float or double

Definition at line 22 of file hart_analysis_context.hpp.

Constructor & Destructor Documentation

AnalysisContext()

template<typename SampleType >

AnalysisContext ( const AudioBuffer< SampleType > &  inputAudio, const AudioBuffer< SampleType > &  outputAudio  )

inline

Creates an instance of analysis context.

You probably have no reason to instantiate this class yourself, it's meand to be created by the AudioTestBuilder only.

Definition at line 28 of file hart_analysis_context.hpp.

Member Function Documentation

inputAudio()

template<typename SampleType >

const AudioBuffer< SampleType > & inputAudio ( ) const

inline

Returns a buffer with input audio.

Definition at line 39 of file hart_analysis_context.hpp.

outputAudio()

template<typename SampleType >

const AudioBuffer< SampleType > & outputAudio ( ) const

inline

Returns a buffer with output audio.

Definition at line 45 of file hart_analysis_context.hpp.

inputSpectrum()

template<typename SampleType >

const Spectrum & inputSpectrum ( ) const

inline

Returns a spectrum of the input audio.

Definition at line 51 of file hart_analysis_context.hpp.

outputSpectrum()

template<typename SampleType >

const Spectrum & outputSpectrum ( ) const

inline

Returns a spectrum of the output audio.

Definition at line 60 of file hart_analysis_context.hpp.

---

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

• include/hart_analysis_context.hpp