Parameters for a spatially correlated Gaussian noise source. More...

#include <correlated_normal_noise.h>

Inheritance diagram for dnf_composer::element::CorrelatedNormalNoiseParameters:

Collaboration diagram for dnf_composer::element::CorrelatedNormalNoiseParameters:

Public Member Functions
	CorrelatedNormalNoiseParameters (double amplitude=0.05, double width=1.0, bool circular=true)
	Construct CorrelatedNormalNoise parameters.

bool	operator== (const CorrelatedNormalNoiseParameters &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
	Noise amplitude (standard deviation before convolution). Default 0.05.

bool	circular
	Use circular (toroidal) boundary for convolution. Default true.

double	width
	Standard deviation of the Gaussian correlation kernel (in samples/indices). Default 1.0.

Detailed Description

Parameters for a spatially correlated Gaussian noise source.

Implements the spatially correlated noise available in cedar's NeuralField. White Gaussian noise is convolved with a Gaussian kernel of the given width to produce spatially smooth noise, then scaled by $\text{amplitude} / \sqrt{\Delta t}$ .

Cross-framework equivalence:

Framework	Equivalent feature
dnf-composer	`CorrelatedNormalNoise(amplitude, width)` element
cedar	NeuralField `NoiseCorrelationKernel` (amplitude + sigma)
cosivina	no built-in equivalent

Note: For uncorrelated noise (width → 0), use NormalNoise instead.

Constructor & Destructor Documentation

◆ CorrelatedNormalNoiseParameters()

dnf_composer::element::CorrelatedNormalNoiseParameters::CorrelatedNormalNoiseParameters	(	double	amplitude = `0.05`,
		double	width = `1.0`,
		bool	circular = `true`
	)

inlineexplicit

Construct CorrelatedNormalNoise parameters.

Parameters

amplitude	Noise amplitude. Default 0.05.
width	Spatial correlation width (sigma of the Gaussian kernel). Default 1.0.
circular	Circular boundary for convolution. Default true.

Member Function Documentation

◆ operator==()

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

inline

◆ toString()

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

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the caller graph for this function:

Member Data Documentation

◆ amplitude

double dnf_composer::element::CorrelatedNormalNoiseParameters::amplitude

Noise amplitude (standard deviation before convolution). Default 0.05.

◆ circular

bool dnf_composer::element::CorrelatedNormalNoiseParameters::circular

Use circular (toroidal) boundary for convolution. Default true.

◆ width

double dnf_composer::element::CorrelatedNormalNoiseParameters::width

Standard deviation of the Gaussian correlation kernel (in samples/indices). Default 1.0.

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

include/elements/correlated_normal_noise.h

Public Member Functions

Public Attributes