Parameters for AsymmetricGaussKernel2D. More...

#include <asymmetric_gauss_kernel_2d.h>

Inheritance diagram for dnf_composer::element::AsymmetricGaussKernel2DParameters:

Collaboration diagram for dnf_composer::element::AsymmetricGaussKernel2DParameters:

Public Member Functions
	AsymmetricGaussKernel2DParameters (double width=3.0, double amplitude=3.0, double amplitudeGlobal=0.0, double timeShift_x=0.0, double timeShift_y=0.0, bool circular=true, bool normalized=true)

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

double	amplitudeGlobal
	Spatially uniform offset added after convolution.

bool	circular
	Enable circular (toroidal) convolution.

bool	normalized
	Normalise the Gaussian before applying amplitude.

double	timeShift_x
	Spatial shift along x (positive = rightward drift).

double	timeShift_y
	Spatial shift along y (positive = downward drift).

double	width
	Gaussian standard deviation σ (same for both axes).

Detailed Description

Parameters for AsymmetricGaussKernel2D.

Mirrors AsymmetricGaussKernelParameters but uses independent time-shift values for the x and y axes, allowing directional drift to be specified per dimension on a 2D field.

Constructor & Destructor Documentation

◆ AsymmetricGaussKernel2DParameters()

dnf_composer::element::AsymmetricGaussKernel2DParameters::AsymmetricGaussKernel2DParameters	(	double	width = `3.0`,
		double	amplitude = `3.0`,
		double	amplitudeGlobal = `0.0`,
		double	timeShift_x = `0.0`,
		double	timeShift_y = `0.0`,
		bool	circular = `true`,
		bool	normalized = `true`
	)

inlineexplicit

Member Function Documentation

◆ operator==()

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

inline

◆ toString()

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

Member Data Documentation

◆ amplitude

double dnf_composer::element::AsymmetricGaussKernel2DParameters::amplitude

Peak amplitude.

◆ amplitudeGlobal

double dnf_composer::element::AsymmetricGaussKernel2DParameters::amplitudeGlobal

Spatially uniform offset added after convolution.

◆ circular

bool dnf_composer::element::AsymmetricGaussKernel2DParameters::circular

Enable circular (toroidal) convolution.

◆ normalized

bool dnf_composer::element::AsymmetricGaussKernel2DParameters::normalized

Normalise the Gaussian before applying amplitude.

◆ timeShift_x

double dnf_composer::element::AsymmetricGaussKernel2DParameters::timeShift_x

Spatial shift along x (positive = rightward drift).

◆ timeShift_y

double dnf_composer::element::AsymmetricGaussKernel2DParameters::timeShift_y

Spatial shift along y (positive = downward drift).

◆ width

double dnf_composer::element::AsymmetricGaussKernel2DParameters::width

Gaussian standard deviation σ (same for both axes).

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

include/elements/asymmetric_gauss_kernel_2d.h

Public Member Functions

Public Attributes