Parameters for an asymmetric (shifted) Gaussian convolution kernel. More...

#include <asymmetric_gauss_kernel.h>

Inheritance diagram for dnf_composer::element::AsymmetricGaussKernelParameters:

Collaboration diagram for dnf_composer::element::AsymmetricGaussKernelParameters:

Public Member Functions
	AsymmetricGaussKernelParameters (const double width=3.0, const double amp=3.0, const double ampGlobal=0.00, const double timeShift=0.00, const bool circular=true, const bool normalized=true)

bool	operator== (const AsymmetricGaussKernelParameters &other) const

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 Gaussian.

double	amplitudeGlobal
	Spatially uniform offset added after convolution.

bool	circular
	Enable circular (toroidal) convolution.

bool	normalized
	Normalise the Gaussian before convolution.

double	timeShift
	Spatial shift of the kernel centre (positive = rightward drift).

double	width
	Gaussian standard deviation σ.

Detailed Description

Parameters for an asymmetric (shifted) Gaussian convolution kernel.

Constructor & Destructor Documentation

◆ AsymmetricGaussKernelParameters()

dnf_composer::element::AsymmetricGaussKernelParameters::AsymmetricGaussKernelParameters	(	const double	width = `3.0`,
		const double	amp = `3.0`,
		const double	ampGlobal = `0.00`,
		const double	timeShift = `0.00`,
		const bool	circular = `true`,
		const bool	normalized = `true`
	)

inlineexplicit

Member Function Documentation

◆ operator==()

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

inline

◆ toString()

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

Member Data Documentation

◆ amplitude

double dnf_composer::element::AsymmetricGaussKernelParameters::amplitude

Peak amplitude of the Gaussian.

◆ amplitudeGlobal

double dnf_composer::element::AsymmetricGaussKernelParameters::amplitudeGlobal

Spatially uniform offset added after convolution.

◆ circular

bool dnf_composer::element::AsymmetricGaussKernelParameters::circular

Enable circular (toroidal) convolution.

◆ normalized

bool dnf_composer::element::AsymmetricGaussKernelParameters::normalized

Normalise the Gaussian before convolution.

◆ timeShift

double dnf_composer::element::AsymmetricGaussKernelParameters::timeShift

Spatial shift of the kernel centre (positive = rightward drift).

◆ width

double dnf_composer::element::AsymmetricGaussKernelParameters::width

Gaussian standard deviation σ.

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

include/elements/asymmetric_gauss_kernel.h

Public Member Functions

Public Attributes