Parameters for a Gaussian lateral interaction kernel. More...

#include <gauss_kernel_parameters.h>

Inheritance diagram for dnf_composer::element::GaussKernelParameters:

Collaboration diagram for dnf_composer::element::GaussKernelParameters:

Public Member Functions
	GaussKernelParameters (const double width=3.0, const double amp=3.0, const double ampGlobal=-0.01, const bool circular=true, const bool normalized=true)

	GaussKernelParameters (double width=5.0, double amp=10.0, bool circular=true, bool normalized=true)

bool	operator== (const GaussKernelParameters &other) const

bool	operator== (const GaussKernelParameters &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	amplitude
	Peak amplitude of the excitatory Gaussian.

double	amplitudeGlobal
	Spatially uniform inhibition added after convolution.

bool	circular
	If true, convolution wraps around (toroidal boundary).

bool	normalized
	If true, the Gaussian is area-normalised.

double	width
	Standard deviation (σ) of the Gaussian.

Detailed Description

Parameters for a Gaussian lateral interaction kernel.

Constructor & Destructor Documentation

◆ GaussKernelParameters() [1/2]

dnf_composer::element::GaussKernelParameters::GaussKernelParameters	(	double	width = `5.0`,
		double	amp = `10.0`,
		bool	circular = `true`,
		bool	normalized = `true`
	)

◆ GaussKernelParameters() [2/2]

dnf_composer::element::GaussKernelParameters::GaussKernelParameters	(	const double	width = `3.0`,
		const double	amp = `3.0`,
		const double	ampGlobal = `-0.01`,
		const bool	circular = `true`,
		const bool	normalized = `true`
	)

inlineexplicit

Member Function Documentation

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

inline

◆ toString() [1/2]

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

overridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

◆ toString() [2/2]

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Member Data Documentation

◆ amplitude

double dnf_composer::element::GaussKernelParameters::amplitude

Peak amplitude of the excitatory Gaussian.

◆ amplitudeGlobal

double dnf_composer::element::GaussKernelParameters::amplitudeGlobal

Spatially uniform inhibition added after convolution.

◆ circular

bool dnf_composer::element::GaussKernelParameters::circular

If true, convolution wraps around (toroidal boundary).

◆ normalized

bool dnf_composer::element::GaussKernelParameters::normalized

If true, the Gaussian is area-normalised.

◆ width

double dnf_composer::element::GaussKernelParameters::width

Standard deviation (σ) of the Gaussian.

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

include/element_parameters/gauss_kernel_parameters.h
include/elements/gauss_kernel.h
src/element_parameters/gauss_kernel_parameters.cpp

Public Member Functions

Public Attributes