Deploying to doxygen from @ e309593 🚀

_audio_cmsis_f_f_t_8h_source.html

@@ -189,9 +189,9 @@
 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;}</div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html">audio_tools::AudioCmsisFFT</a></div><div class="ttdoc">AudioFFT for ARM processors that provided Cmsis DSP.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:112</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html_a66ae48c63153a8973ad0b5b2d95f86a1"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html#a66ae48c63153a8973ad0b5b2d95f86a1">audio_tools::AudioCmsisFFT::array</a></div><div class="ttdeci">float * array()</div><div class="ttdoc">Provides the result array returned by CMSIS FFT.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:117</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT im...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:122</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a737190d3d351f65b5184f7c8047a2fb7"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a737190d3d351f65b5184f7c8047a2fb7">audio_tools::AudioFFTBase::AudioFFTBase</a></div><div class="ttdeci">AudioFFTBase(FFTDriver *driver)</div><div class="ttdoc">Default Constructor. The len needs to be of the power of 2 (e.g. 512, 1024, 2048, 4096,...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:125</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_ad360e5c2be36d28d74715e70f31a9f98"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#ad360e5c2be36d28d74715e70f31a9f98">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdoc">provides access to the FFTDriver which implements the basic FFT functionality</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:286</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT im...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:123</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a737190d3d351f65b5184f7c8047a2fb7"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a737190d3d351f65b5184f7c8047a2fb7">audio_tools::AudioFFTBase::AudioFFTBase</a></div><div class="ttdeci">AudioFFTBase(FFTDriver *driver)</div><div class="ttdoc">Default Constructor. The len needs to be of the power of 2 (e.g. 512, 1024, 2048, 4096,...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:126</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_ad360e5c2be36d28d74715e70f31a9f98"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#ad360e5c2be36d28d74715e70f31a9f98">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdoc">provides access to the FFTDriver which implements the basic FFT functionality</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:287</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html">audio_tools::FFTDriverCmsisFFT</a></div><div class="ttdoc">Driver for Cmsis-FFT see https://arm-software.github.io/CMSIS_5/DSP.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:23</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a01f7d08ca15b0ebd7bb4d17101ba8d72"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a01f7d08ca15b0ebd7bb4d17101ba8d72">audio_tools::FFTDriverCmsisFFT::magnitudeFast</a></div><div class="ttdeci">float magnitudeFast(int idx) override</div><div class="ttdoc">same as magnitude</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:72</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a11592af256fefabe7c1e1cc9b8b516b6"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a11592af256fefabe7c1e1cc9b8b516b6">audio_tools::FFTDriverCmsisFFT::setValue</a></div><div class="ttdeci">void setValue(int idx, float value) override</div><div class="ttdoc">Sets the real value.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:50</div></div>
@@ -202,9 +202,9 @@
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_ab08cf2f66075519cfdaddedcce92527f"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#ab08cf2f66075519cfdaddedcce92527f">audio_tools::FFTDriverCmsisFFT::fft</a></div><div class="ttdeci">void fft() override</div><div class="ttdoc">Perform FFT.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:54</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_add3df8e9c88c438537a87be3415ef2ba"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#add3df8e9c88c438537a87be3415ef2ba">audio_tools::FFTDriverCmsisFFT::rfft</a></div><div class="ttdeci">void rfft() override</div><div class="ttdoc">Calculate reverse FFT.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:63</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_aec550aae099c1a4afec6a9df3512ad21"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#aec550aae099c1a4afec6a9df3512ad21">audio_tools::FFTDriverCmsisFFT::getValue</a></div><div class="ttdeci">float getValue(int idx) override</div><div class="ttdoc">Get result value from Reverse FFT.</div><div class="ttdef"><b>Definition:</b> AudioCmsisFFT.h:76</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:89</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:90</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:12</div></div>
-<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:60</div></div>
+<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:61</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

_audio_e_s_p32_f_f_t_8h_source.html

@@ -147,9 +147,9 @@
 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_e_s_p32_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_e_s_p32_f_f_t.html">audio_tools::AudioESP32FFT</a></div><div class="ttdoc">AudioFFT using RealFFT.</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:84</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_e_s_p32_f_f_t_html_a66ae48c63153a8973ad0b5b2d95f86a1"><div class="ttname"><a href="classaudio__tools_1_1_audio_e_s_p32_f_f_t.html#a66ae48c63153a8973ad0b5b2d95f86a1">audio_tools::AudioESP32FFT::array</a></div><div class="ttdeci">float * array()</div><div class="ttdoc">Provides the result array returned by the FFT: The real part of a magnitude at a frequency is followe...</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:89</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT im...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:122</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a737190d3d351f65b5184f7c8047a2fb7"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a737190d3d351f65b5184f7c8047a2fb7">audio_tools::AudioFFTBase::AudioFFTBase</a></div><div class="ttdeci">AudioFFTBase(FFTDriver *driver)</div><div class="ttdoc">Default Constructor. The len needs to be of the power of 2 (e.g. 512, 1024, 2048, 4096,...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:125</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_ad360e5c2be36d28d74715e70f31a9f98"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#ad360e5c2be36d28d74715e70f31a9f98">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdoc">provides access to the FFTDriver which implements the basic FFT functionality</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:286</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT im...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:123</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a737190d3d351f65b5184f7c8047a2fb7"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a737190d3d351f65b5184f7c8047a2fb7">audio_tools::AudioFFTBase::AudioFFTBase</a></div><div class="ttdeci">AudioFFTBase(FFTDriver *driver)</div><div class="ttdoc">Default Constructor. The len needs to be of the power of 2 (e.g. 512, 1024, 2048, 4096,...</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:126</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_ad360e5c2be36d28d74715e70f31a9f98"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#ad360e5c2be36d28d74715e70f31a9f98">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdoc">provides access to the FFTDriver which implements the basic FFT functionality</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:287</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html">audio_tools::FFTDriverESP32FFT</a></div><div class="ttdoc">Driver for ESP32-FFT https://github.com/pschatzmann/esp32-fft</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:21</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a01f7d08ca15b0ebd7bb4d17101ba8d72"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a01f7d08ca15b0ebd7bb4d17101ba8d72">audio_tools::FFTDriverESP32FFT::magnitudeFast</a></div><div class="ttdeci">float magnitudeFast(int idx) override</div><div class="ttdoc">magnitude w/o sqrt</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:49</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a09c13a7b0d31155679c3285b4e19d334"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a09c13a7b0d31155679c3285b4e19d334">audio_tools::FFTDriverESP32FFT::getValue</a></div><div class="ttdeci">float getValue(int idx)</div><div class="ttdoc">Get result value from Reverse FFT.</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:53</div></div>
@@ -160,9 +160,9 @@
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a7adfa4b95180c0520f797ce976e9fb58"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a7adfa4b95180c0520f797ce976e9fb58">audio_tools::FFTDriverESP32FFT::magnitude</a></div><div class="ttdeci">float magnitude(int idx) override</div><div class="ttdoc">Calculate the magnitude (fft result) at index (sqr(i² + r²))</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:44</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_ab08cf2f66075519cfdaddedcce92527f"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#ab08cf2f66075519cfdaddedcce92527f">audio_tools::FFTDriverESP32FFT::fft</a></div><div class="ttdeci">void fft() override</div><div class="ttdoc">Perform FFT.</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:36</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_add3df8e9c88c438537a87be3415ef2ba"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#add3df8e9c88c438537a87be3415ef2ba">audio_tools::FFTDriverESP32FFT::rfft</a></div><div class="ttdeci">void rfft() override</div><div class="ttdoc">Calculate reverse FFT.</div><div class="ttdef"><b>Definition:</b> AudioESP32FFT.h:40</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:89</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:90</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:12</div></div>
-<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:60</div></div>
+<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:61</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>