noise::ClockModelGenerator Class Reference

Generates noise using a clock model with multiple rates. More...

#include "noise_generators.h"

Inheritance diagram for noise::ClockModelGenerator:

Collaboration diagram for noise::ClockModelGenerator:

Public Member Functions
	ClockModelGenerator (std::mt19937 &rngEngine, const std::vector< RealType > &alpha, const std::vector< RealType > &inWeights, RealType frequency, RealType phaseOffset, RealType freqOffset, int branches) noexcept
	Constructor to initialize the clock model generator.
RealType	getSample () override
	Generates a clock model noise sample.
void	skipSamples (long long samples)
	Skips a number of samples in the noise sequence.
void	reset ()
	Resets the noise generator state.
bool	enabled () const
	Checks if the noise generator is enabled.

Detailed Description

Generates noise using a clock model with multiple rates.

This is useful for simulating clock jitter or other similar phenomena.

Definition at line 169 of file noise_generators.h.

Constructor & Destructor Documentation

ClockModelGenerator()

noise::ClockModelGenerator::ClockModelGenerator ( std::mt19937 &  rngEngine, const std::vector< RealType > &  alpha, const std::vector< RealType > &  inWeights, RealType  frequency, RealType  phaseOffset, RealType  freqOffset, int  branches  )

noexcept

Constructor to initialize the clock model generator.

Parameters

rngEngine	The random number engine to use for generation.
alpha	Vector of scaling parameters for the noise.
inWeights	Vector of weights for each rate process.
frequency	The base frequency of the clock model.
phaseOffset	The phase offset of the generated noise.
freqOffset	The frequency offset of the generated noise.
branches	The number of branches in each rate process.

Definition at line 102 of file noise_generators.cpp.

                                                                    :
        _rng_engine(rngEngine), _weights(inWeights), _phase_offset(phaseOffset), _freq_offset(freqOffset),
        _frequency(frequency)
    {
        for (size_t i = 0; i < alpha.size(); ++i)
        {
            auto mgen = std::make_unique<MultirateGenerator>(_rng_engine.get(), alpha[i], branches);
            _generators.push_back(std::move(mgen));
 
            switch (static_cast<int>(alpha[i]))
            {
            case 2:
                _weights[i] *= std::pow(10.0, 1.225);
                break;
            case 1:
                _weights[i] *= std::pow(10.0, 0.25);
                break;
            case 0:
                _weights[i] *= std::pow(10.0, -0.25);
                break;
            case -1:
                _weights[i] *= std::pow(10.0, -0.5);
                break;
            case -2:
                _weights[i] *= std::pow(10.0, -1.0);
                break;
            default:
                break;
            }
        }
    }

Member Function Documentation

enabled()

bool noise::ClockModelGenerator::enabled

(

)

const

Checks if the noise generator is enabled.

Returns

True if the generator is enabled, false otherwise.

Definition at line 172 of file noise_generators.cpp.

    {
        return !_generators.empty() || _freq_offset != 0 || _phase_offset != 0;
    }

getSample()

RealType noise::ClockModelGenerator::getSample ( )

overridevirtual

Generates a clock model noise sample.

Returns

A noise sample of type RealType.

Implements noise::NoiseGenerator.

Definition at line 137 of file noise_generators.cpp.

    {
        RealType sample = 0;
        for (size_t i = 0; i < _generators.size(); ++i)
        {
            sample += _generators[i]->getSample() * _weights[i];
        }
 
        sample += _phase_offset;
        sample += 2 * PI * _freq_offset * static_cast<double>(_count) / params::rate();
        ++_count;
 
        return sample;
    }

References PI, and params::rate().

Here is the call graph for this function:

reset()

void noise::ClockModelGenerator::reset

(

)

Resets the noise generator state.

Definition at line 161 of file noise_generators.cpp.

    {
        // reset() call chain is only called if sync on pulse is enabled,
        // otherwise the all generators and counts remain as-is
        for (const auto& generator : _generators)
        {
            generator->reset();
        }
        _count = 0;
    }

skipSamples()

void noise::ClockModelGenerator::skipSamples

(

long long

samples

)

Skips a number of samples in the noise sequence.

Parameters

samples

The number of samples to skip.

Definition at line 152 of file noise_generators.cpp.

    {
        for (const auto& generator : _generators)
        {
            generator->skipSamples(samples);
        }
        _count += samples;
    }

---

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

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