FrequencySpectrum.hpp

Go to the documentation of this file.

 
#ifndef ECHOMAP_FREQUENCYSPECTRUM_HPP
#define ECHOMAP_FREQUENCYSPECTRUM_HPP
 
#include <vector>
 
#include "Object.hpp"
#include "factories/WindowFunctions.hpp"
 
namespace echomap
{
 
class FrequencySpectrumFactory;

class FrequencySpectrum : public Object<FrequencySpectrum>
{
public:
    struct Bin
    {
        float frequency; 
        float magnitude; 
        float phase;     
    };
 
private:
    std::vector<Bin> bins;
 
public:
    [[nodiscard]] decltype(bins)::const_iterator begin() const;
    [[nodiscard]] decltype(bins)::const_iterator end() const;
    [[nodiscard]] decltype(bins)::const_iterator cbegin() const noexcept;
    [[nodiscard]] decltype(bins)::const_iterator cend() const noexcept;
 
    [[nodiscard]] std::size_t get_bin_count() const noexcept;
 
    [[nodiscard]] float get_minimum_frequency() const noexcept;
    [[nodiscard]] float get_maximum_frequency() const noexcept;
    [[nodiscard]] float get_minimum_magnitude() const noexcept;
    [[nodiscard]] float get_maximum_magnitude() const noexcept;
 
    const WindowFunctions::AllFunctions& observe_preprocessor() const noexcept;
 
private:
    friend FrequencySpectrumFactory;
 
    explicit FrequencySpectrum(
            WindowFunctions::AllFunctions preprocessor,
            std::string_view name
    );
 
    void reserve_bins(std::size_t bin_count);
 
    void emplace_bin(
            float frequency,
            float magnitude,
            float phase
    );
 
    WindowFunctions::AllFunctions preprocessor;
 
    float minimum_frequency = std::numeric_limits<float>::max();
    float maximum_frequency = std::numeric_limits<float>::min();
    float minimum_magnitude = std::numeric_limits<float>::max();
    float maximum_magnitude = std::numeric_limits<float>::min();
};
 
template <> constexpr std::string_view Object<FrequencySpectrum>::class_name = "FreqSpec";
 
} // namespace echomap
 
#endif // ECHOMAP_FREQUENCYSPECTRUM_HPP