Parameters for a Gaussian-shaped external stimulus. More...

#include <gauss_stimulus_parameters.h>

Inheritance diagram for dnf_composer::element::GaussStimulusParameters:

Collaboration diagram for dnf_composer::element::GaussStimulusParameters:

Public Member Functions
	GaussStimulusParameters (const double width=5.0, const double amplitude=15.0, const double position=50.0, const bool circular=true, const bool normalized=false)
	Construct a GaussStimulus parameter set.

	GaussStimulusParameters (double width=5.0, double amplitude=15.0, double position=0.0, bool circular=true, bool normalized=false)

bool	operator== (const GaussStimulusParameters &other) const

bool	operator== (const GaussStimulusParameters &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.

bool	circular
	If true, the stimulus wraps at the field boundary.

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

double	position
	Spatial position (centre) of the Gaussian.

double	width
	Standard deviation (σ) of the Gaussian bump.

Detailed Description

Parameters for a Gaussian-shaped external stimulus.

Constructor & Destructor Documentation

◆ GaussStimulusParameters() [1/2]

dnf_composer::element::GaussStimulusParameters::GaussStimulusParameters	(	double	width = `5.0`,
		double	amplitude = `15.0`,
		double	position = `0.0`,
		bool	circular = `true`,
		bool	normalized = `false`
	)

◆ GaussStimulusParameters() [2/2]

dnf_composer::element::GaussStimulusParameters::GaussStimulusParameters	(	const double	width = `5.0`,
		const double	amplitude = `15.0`,
		const double	position = `50.0`,
		const bool	circular = `true`,
		const bool	normalized = `false`
	)

inlineexplicit

Construct a GaussStimulus parameter set.

Parameters

width	Gaussian σ (default 5).
amplitude	Peak value (default 15).
position	Centre in spatial coordinates (default 50).
circular	Circular/toroidal boundary (default true).
normalized	Area normalization (default false).

Member Function Documentation

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

inline

◆ toString() [1/2]

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

overridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

◆ toString() [2/2]

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Member Data Documentation

◆ amplitude

double dnf_composer::element::GaussStimulusParameters::amplitude

Peak amplitude.

◆ circular

bool dnf_composer::element::GaussStimulusParameters::circular

If true, the stimulus wraps at the field boundary.

◆ normalized

bool dnf_composer::element::GaussStimulusParameters::normalized

If true, the Gaussian is area-normalised.

◆ position

double dnf_composer::element::GaussStimulusParameters::position

Spatial position (centre) of the Gaussian.

◆ width

double dnf_composer::element::GaussStimulusParameters::width

Standard deviation (σ) of the Gaussian bump.

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

include/element_parameters/gauss_stimulus_parameters.h
include/elements/gauss_stimulus.h
src/element_parameters/gauss_stimulus_parameters.cpp

Public Member Functions

Public Attributes