Parameters for an oscillatory (damped-cosine) convolution kernel. More...

#include <oscillatory_kernel.h>

Inheritance diagram for dnf_composer::element::OscillatoryKernelParameters:

Collaboration diagram for dnf_composer::element::OscillatoryKernelParameters:

Public Member Functions
bool	operator== (const OscillatoryKernelParameters &other) const

	OscillatoryKernelParameters (const double amplitude=1.0, const double decay=0.08, const double zeroCrossings=0.3, const double amplitudeGlobal=-0.01, const bool circular=true, const bool normalized=false)

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
	Overall kernel amplitude.

double	amplitudeGlobal
	Spatially uniform inhibition added after convolution.

bool	circular
	Enable circular (toroidal) convolution.

double	decay
	Exponential envelope decay rate (must be > 0).

bool	normalized
	Normalise the kernel before convolution.

double	zeroCrossings
	Spatial frequency controlling oscillation period (clamped to [0, 1]).

Detailed Description

Parameters for an oscillatory (damped-cosine) convolution kernel.

Constructor & Destructor Documentation

◆ OscillatoryKernelParameters()

dnf_composer::element::OscillatoryKernelParameters::OscillatoryKernelParameters	(	const double	amplitude = `1.0`,
		const double	decay = `0.08`,
		const double	zeroCrossings = `0.3`,
		const double	amplitudeGlobal = `-0.01`,
		const bool	circular = `true`,
		const bool	normalized = `false`
	)

inlineexplicit

Member Function Documentation

◆ operator==()

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

inline

◆ toString()

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

Member Data Documentation

◆ amplitude

double dnf_composer::element::OscillatoryKernelParameters::amplitude

Overall kernel amplitude.

◆ amplitudeGlobal

double dnf_composer::element::OscillatoryKernelParameters::amplitudeGlobal

Spatially uniform inhibition added after convolution.

◆ circular

bool dnf_composer::element::OscillatoryKernelParameters::circular

Enable circular (toroidal) convolution.

◆ decay

double dnf_composer::element::OscillatoryKernelParameters::decay

Exponential envelope decay rate (must be > 0).

◆ normalized

bool dnf_composer::element::OscillatoryKernelParameters::normalized

Normalise the kernel before convolution.

◆ zeroCrossings

double dnf_composer::element::OscillatoryKernelParameters::zeroCrossings

Spatial frequency controlling oscillation period (clamped to [0, 1]).

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

include/elements/oscillatory_kernel.h

Public Member Functions

Public Attributes