noise::WgnGenerator Class Reference

Generates white Gaussian noise. More...

#include "noise_generators.h"

Inheritance diagram for noise::WgnGenerator:

Collaboration diagram for noise::WgnGenerator:

Public Member Functions
	WgnGenerator (std::mt19937 &rngEngine, const RealType stddev=1.0) noexcept
	Constructor to initialize the WGN generator with a given standard deviation.
RealType	getSample () noexcept override
	Generates a sample of white Gaussian noise.

Detailed Description

Generates white Gaussian noise.

Definition at line 56 of file noise_generators.h.

Constructor & Destructor Documentation

WgnGenerator()

noise::WgnGenerator::WgnGenerator ( std::mt19937 &  rngEngine, const RealType  stddev = 1.0  )

explicitnoexcept

Constructor to initialize the WGN generator with a given standard deviation.

Parameters

rngEngine	The random number engine to use for generation.
stddev	The standard deviation of the generated Gaussian noise. Default is 1.0.

Definition at line 65 of file noise_generators.h.

                                                                                           :
            _rng_engine(rngEngine), _dist(0.0, stddev), _stddev(stddev)
        {
        }

Member Function Documentation

getSample()

RealType noise::WgnGenerator::getSample ( )

overridevirtualnoexcept

Generates a sample of white Gaussian noise.

Returns

A noise sample of type RealType.

Implements noise::NoiseGenerator.

Definition at line 75 of file noise_generators.h.

{ return _dist(_rng_engine.get()); }

Referenced by processing::applyThermalNoise().

Here is the caller graph for this function:

---

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

• packages/libfers/src/noise/noise_generators.h