Threshold comparator with hysteresis — the bridge from the signal domain to the event domain. More...

#include <mod_tools.hpp>

Public Member Functions
void	set_threshold (SampleType t)
	Setting a threshold re-derives the default hysteresis unless an explicit one was set first.
void	set_hysteresis (SampleType h)
	Absolute dead band, in the input's units.
void	reset (bool gate=false)
bool	process (SampleType x)
bool	gate () const
SampleType	hysteresis () const

Static Public Attributes
static constexpr SampleType	kDefaultHysteresisFraction = SampleType{0.05}
	Default dead band, as a fraction of the threshold magnitude.
static constexpr SampleType	kMinAutoHysteresis = SampleType{0.001}
	Floor for the derived dead band.

Detailed Description

template<typename SampleType = float>
class pulp::signal::ComparatorT< SampleType >

Threshold comparator with hysteresis — the bridge from the signal domain to the event domain.

The gate goes high above threshold + hysteresis and low below threshold - hysteresis. Without the dead band, a source that dithers across the threshold — which is every real modulation signal, including a slow sine near its own zero crossing — chatters the gate on and off at the sample rate.

RT contract: one bool of state; process() and reset() allocate nothing.

USE: turning any modulation signal into a clock or a gate. An LFO through a comparator is a clock whose duty cycle is the threshold. An envelope through a comparator is "the note is loud enough to count".