mexican_hat_kernel.h

Go to the documentation of this file.

#pragma once
 
#include <vector>
#include <string>
#include <array>
 
#include "kernel.h"
#include "tools/math.h"
 
#ifdef max
#undef max
#endif
 
#ifdef min
#undef min
#endif
 
 
namespace dnf_composer::element
{
    struct MexicanHatKernelParameters final : ElementSpecificParameters
    {
        double widthExc;          
        double amplitudeExc;      
        double widthInh;          
        double amplitudeInh;      
        double amplitudeGlobal;   
        bool circular;            
        bool normalized;          
 
        explicit MexicanHatKernelParameters(const double widthExc = 2.5, const double amplitudeExc = 11.0,
                                   const double widthInh = 5.0, const double amplitudeInh = 15.0,
                                   const double amplitudeGlobal = -0.1,
                                   const bool circular = true, const bool normalized = true)
            : widthExc(widthExc), amplitudeExc(amplitudeExc),
              widthInh(widthInh), amplitudeInh(amplitudeInh),
              amplitudeGlobal(amplitudeGlobal),
              circular(circular), normalized(normalized)
        {}
 
        bool operator==(const MexicanHatKernelParameters& other) const
        {
            constexpr double epsilon = 1e-6;
 
            return std::abs(widthExc - other.widthExc) < epsilon &&
                std::abs(amplitudeExc - other.amplitudeExc) < epsilon &&
                std::abs(widthInh - other.widthInh) < epsilon &&
                std::abs(amplitudeInh - other.amplitudeInh) < epsilon &&
                std::abs(amplitudeGlobal - other.amplitudeGlobal) < epsilon &&
                circular == other.circular &&
                normalized == other.normalized;
        }
 
        [[nodiscard]] std::string toString() const override
        {
            std::ostringstream result;
            result << std::fixed << std::setprecision(2);
            result << "Parameters: ["
                << "Width exc.: " << widthExc << ", "
                << "Amplitude exc.: " << amplitudeExc << ", "
                << "Width inh.: " << widthInh << ", "
                << "Amplitude inh.: " << amplitudeInh << ", "
                << "Amplitude glob.: " << amplitudeGlobal << ", "
                << "Circular: " << (circular ? "true" : "false") << ", "
                << "Normalized: " << (normalized ? "true" : "false") << "]";
            return result.str();
        }
    };
 
    class MexicanHatKernel final : public Kernel
    {
    private:
        MexicanHatKernelParameters parameters;
        std::vector<double> scratchExtended;
        std::vector<double> scratchConvolution;
    public:
        MexicanHatKernel(const ElementCommonParameters& elementCommonParameters,
                         MexicanHatKernelParameters mhk_parameters);
 
        void init() override;
        void step(double t, double deltaT) override;
        std::string toString() const override;
        std::shared_ptr<Element> clone() const override;
 
        void setParameters(const MexicanHatKernelParameters& mhk_parameters);
        MexicanHatKernelParameters getParameters() const;
    };
}