Parameters for OscillatoryKernel2D. More...

#include <oscillatory_kernel_2d.h>

Inheritance diagram for dnf_composer::element::OscillatoryKernel2DParameters:

Collaboration diagram for dnf_composer::element::OscillatoryKernel2DParameters:

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

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

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

double	amplitudeGlobal

bool	circular

double	decay

bool	normalized

double	zeroCrossings

Detailed Description

Parameters for OscillatoryKernel2D.

Mirrors OscillatoryKernelParameters. zeroCrossings are clamped to [0, 1]; decay must be positive.

Constructor & Destructor Documentation

◆ OscillatoryKernel2DParameters()

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

inlineexplicit

Member Function Documentation

◆ operator==()

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

inline

◆ toString()

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

Member Data Documentation

◆ amplitude

double dnf_composer::element::OscillatoryKernel2DParameters::amplitude

◆ amplitudeGlobal

double dnf_composer::element::OscillatoryKernel2DParameters::amplitudeGlobal

◆ circular

bool dnf_composer::element::OscillatoryKernel2DParameters::circular

◆ decay

double dnf_composer::element::OscillatoryKernel2DParameters::decay

◆ normalized

bool dnf_composer::element::OscillatoryKernel2DParameters::normalized

◆ zeroCrossings

double dnf_composer::element::OscillatoryKernel2DParameters::zeroCrossings

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

include/elements/oscillatory_kernel_2d.h

Public Member Functions

Public Attributes