pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands > Class Template Reference

#include <spectrum_trace.hpp>

Public Types
using	Frame = SpectrumTraceFrameT<SampleType, MaxBands>

Public Member Functions
	SpectrumTraceT () noexcept
bool	configure (const SpectrumTraceConfig &config) noexcept
	Control-thread operation.
bool	process_frame (std::span< const SampleType > magnitude_db) noexcept
	Rejected frames leave the current trace and sequence unchanged.
void	reset () noexcept
const Frame &	current () const noexcept
	Same-thread view. This reference is not a concurrent publication API.
const SpectrumTraceConfig &	config () const noexcept
std::size_t	input_bin_count () const noexcept

Static Public Member Functions
static constexpr std::uint32_t	algorithmic_latency_samples () noexcept

Member Typedef Documentation

Frame

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

using pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::Frame = SpectrumTraceFrameT<SampleType, MaxBands>

Constructor & Destructor Documentation

SpectrumTraceT()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::SpectrumTraceT ( )

inlinenoexcept

Member Function Documentation

algorithmic_latency_samples()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

constexpr std::uint32_t pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::algorithmic_latency_samples ( )

inlinestaticnodiscardconstexprnoexcept

config()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

const SpectrumTraceConfig & pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::config ( ) const

inlinenodiscardnoexcept

configure()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

bool pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::configure ( const SpectrumTraceConfig & config )

inlinenodiscardnoexcept

Control-thread operation.

Invalid configurations are rejected without changing the current configuration or trace.

current()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

const Frame & pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::current ( ) const

inlinenodiscardnoexcept

Same-thread view. This reference is not a concurrent publication API.

input_bin_count()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

std::size_t pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::input_bin_count ( ) const

inlinenodiscardnoexcept

process_frame()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

bool pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::process_frame ( std::span< const SampleType > magnitude_db )

inlinenodiscardnoexcept

Rejected frames leave the current trace and sequence unchanged.

reset()

template<typename SampleType = float, std::size_t MaxInputBins = 4097, std::size_t MaxBands = 256>

void pulp::signal::SpectrumTraceT< SampleType, MaxInputBins, MaxBands >::reset ( )

inlinenoexcept

---

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

• /home/runner/work/pulp/pulp/core/signal/include/pulp/signal/spectrum_trace.hpp