noise::FAlphaBranch Class Reference

Class responsible for generating fractional and integer noise components. More...

#include "falpha_branch.h"

Public Member Functions
	FAlphaBranch (std::mt19937 &rngEngine, RealType ffrac, unsigned fint, std::unique_ptr< FAlphaBranch > pre, bool last)
	Constructor for FAlphaBranch.
	~FAlphaBranch ()=default
	FAlphaBranch (const FAlphaBranch &)=delete
FAlphaBranch &	operator= (const FAlphaBranch &)=delete
	FAlphaBranch (FAlphaBranch &&)=delete
FAlphaBranch &	operator= (FAlphaBranch &&)=delete
RealType	getSample () noexcept
	Retrieves the current noise sample.
void	flush (RealType scale)
	Flushes the branch with a new scaling factor.
FAlphaBranch *	getPre () const noexcept
	Retrieves the previous branch in the chain.

Detailed Description

Class responsible for generating fractional and integer noise components.

The FAlphaBranch class generates noise by applying a fractional integrator filter. It uses a series of filters and upsamplers to process and shape the noise signal.

Definition at line 32 of file falpha_branch.h.

Constructor & Destructor Documentation

FAlphaBranch() [1/3]

noise::FAlphaBranch::FAlphaBranch	(	std::mt19937 &	rngEngine,
		RealType	ffrac,
		unsigned	fint,
		std::unique_ptr< FAlphaBranch >	pre,
		bool	last
	)

Constructor for FAlphaBranch.

Parameters

rngEngine	The random number generator engine to use.
ffrac	Fractional part of the noise generation (e.g., 0.5 for 1/f noise).
fint	Integer part of the noise generation (e.g., 1 for integration).
pre	Previous stage of the FAlphaBranch for recursive noise processing.
last	Specifies if this is the last branch in the chain of processing.

Definition at line 30 of file falpha_branch.cpp.

                                                                                 :
        _rng_engine_ref(rngEngine), _normal_dist{0.0, 1.0}, _pre(std::move(pre)), _buffer(10), _ffrac(ffrac),
        _fint(fint), _last(last)
    {
        LOG(Level::TRACE, "Creating FAlphaBranch: ffrac={} fint={}", ffrac, fint);
        _upsample_scale = std::pow(10, ffrac + fint + 0.5);
        init();
 
        if (!_last)
        {
            refill();
        }
    }

References LOG.

~FAlphaBranch()

noise::FAlphaBranch::~FAlphaBranch ( )

default

FAlphaBranch() [2/3]

noise::FAlphaBranch::FAlphaBranch ( const FAlphaBranch &  )

delete

FAlphaBranch() [3/3]

noise::FAlphaBranch::FAlphaBranch ( FAlphaBranch &&  )

delete

Member Function Documentation

flush()

void noise::FAlphaBranch::flush

(

RealType

scale

)

Flushes the branch with a new scaling factor.

Parameters

scale

New scale factor to apply to the previous stage.

Definition at line 168 of file falpha_branch.cpp.

    {
        init();
        _pre_scale = scale;
    }

Referenced by noise::MultirateGenerator::reset().

Here is the caller graph for this function:

getPre()

FAlphaBranch * noise::FAlphaBranch::getPre ( ) const

noexcept

Retrieves the previous branch in the chain.

Returns

Pointer to the previous FAlphaBranch, or nullptr if none exists.

Definition at line 76 of file falpha_branch.h.

{ return _pre.get(); }

Referenced by noise::MultirateGenerator::reset(), and noise::MultirateGenerator::skipSamples().

Here is the caller graph for this function:

getSample()

RealType noise::FAlphaBranch::getSample ( )

noexcept

Retrieves the current noise sample.

Returns

The current noise sample.

Definition at line 109 of file falpha_branch.cpp.

    {
        if (!_last)
        {
            const RealType ret = _buffer[_buffer_samples++];
            if (_buffer_samples == 10)
            {
                refill();
            }
            return ret;
        }
        return calcSample() + _offset_sample * _upsample_scale;
    }

Referenced by noise::MultirateGenerator::skipSamples().

Here is the caller graph for this function:

operator=() [1/2]

FAlphaBranch & noise::FAlphaBranch::operator= ( const FAlphaBranch &  )

delete

operator=() [2/2]

FAlphaBranch & noise::FAlphaBranch::operator= ( FAlphaBranch &&  )

delete

---

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

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