Parameters for a Mexican-hat lateral interaction kernel. More...

#include <mexican_hat_kernel_parameters.h>

Inheritance diagram for dnf_composer::element::MexicanHatKernelParameters:

Collaboration diagram for dnf_composer::element::MexicanHatKernelParameters:

Public Member Functions
	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)

	MexicanHatKernelParameters (double widthExc, double amplitudeExc, double widthInh, double amplitudeInh, bool circular=true, bool normalized=true)

bool	operator== (const MexicanHatKernelParameters &other) const

bool	operator== (const MexicanHatKernelParameters &other) const

std::string	toString () const override

std::string	toString () const override

Public Member Functions inherited from dnf_composer::element::ElementSpecificParameters
	ElementSpecificParameters ()=default

void	print () const

virtual	~ElementSpecificParameters ()=default

Public Attributes
double	amplitudeExc
	Peak amplitude of the excitatory Gaussian.

double	amplitudeGlobal
	Spatially uniform inhibition added after convolution.

double	amplitudeInh
	Peak amplitude of the inhibitory Gaussian.

bool	circular
	Enable circular (toroidal) convolution.

bool	normalized
	Normalise both Gaussians before differencing.

double	widthExc
	σ of the excitatory Gaussian.

double	widthInh
	σ of the inhibitory Gaussian.

Detailed Description

Parameters for a Mexican-hat lateral interaction kernel.

A Mexican-hat kernel is the difference of two Gaussians: a narrow excitatory Gaussian minus a wider inhibitory Gaussian, plus a global inhibition constant. This combination produces local self-excitation with surrounding lateral inhibition, the standard interaction profile for winner-takes-all selection fields.

Constructor & Destructor Documentation

◆ MexicanHatKernelParameters() [1/2]

dnf_composer::element::MexicanHatKernelParameters::MexicanHatKernelParameters	(	double	widthExc,
		double	amplitudeExc,
		double	widthInh,
		double	amplitudeInh,
		bool	circular = `true`,
		bool	normalized = `true`
	)

◆ MexicanHatKernelParameters() [2/2]

dnf_composer::element::MexicanHatKernelParameters::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`
	)

inlineexplicit

Member Function Documentation

◆ operator==() [1/2]

bool dnf_composer::element::MexicanHatKernelParameters::operator== ( const MexicanHatKernelParameters & other ) const

◆ operator==() [2/2]

bool dnf_composer::element::MexicanHatKernelParameters::operator== ( const MexicanHatKernelParameters & other ) const

inline

◆ toString() [1/2]

std::string dnf_composer::element::MexicanHatKernelParameters::toString ( ) const

overridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

◆ toString() [2/2]

std::string dnf_composer::element::MexicanHatKernelParameters::toString ( ) const

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Member Data Documentation

◆ amplitudeExc

double dnf_composer::element::MexicanHatKernelParameters::amplitudeExc

Peak amplitude of the excitatory Gaussian.

◆ amplitudeGlobal

double dnf_composer::element::MexicanHatKernelParameters::amplitudeGlobal

Spatially uniform inhibition added after convolution.

◆ amplitudeInh

double dnf_composer::element::MexicanHatKernelParameters::amplitudeInh

Peak amplitude of the inhibitory Gaussian.

◆ circular

bool dnf_composer::element::MexicanHatKernelParameters::circular

Enable circular (toroidal) convolution.

◆ normalized

bool dnf_composer::element::MexicanHatKernelParameters::normalized

Normalise both Gaussians before differencing.

◆ widthExc

double dnf_composer::element::MexicanHatKernelParameters::widthExc

σ of the excitatory Gaussian.

◆ widthInh

double dnf_composer::element::MexicanHatKernelParameters::widthInh

σ of the inhibitory Gaussian.

The documentation for this struct was generated from the following files:

include/element_parameters/mexican_hat_kernel_parameters.h
include/elements/mexican_hat_kernel.h
src/element_parameters/mexican_hat_kernel_parameters.cpp

Public Member Functions

Public Attributes