Stateful direct-form II transposed IIR filter. More...

#include <fft.H>

Collaboration diagram for Aleph::FFT< Real >::LFilter:

Public Member Functions
	LFilter ()=default
	Default constructor for an unconfigured LFilter.

	LFilter (const Array< Real > &numerator, const Array< Real > &denominator)
	Construct a linear filter from numerator and denominator arrays.

	LFilter (const IIRCoefficients &coeffs)
	Construct a linear filter from IIRCoefficients.

	LFilter (const BiquadSection &section)
	Construct a linear filter from a single BiquadSection.

template<typename NumContainer , typename DenContainer > requires Is_Real_Container<NumContainer>
and Is_Real_Container< DenContainer >	LFilter (const NumContainer &numerator, const DenContainer &denominator)
	Construct a linear filter from any real containers.

size_t	order () const noexcept
	Returns the filter order (number of feedback coefficients - 1).

bool	configured () const noexcept
	Returns whether the filter has been initialized with coefficients.

const IIRCoefficients &	coefficients () const noexcept
	Returns the active normalized filter coefficients.

const Array< Real > &	state () const noexcept
	Returns the current internal delay-line state.

void	reset ()
	Resets the delay-line state to zero.

void	set_state (const Array< Real > &new_state)
	Manually overrides the delay-line state.

Array< Real >	filter (const Array< Real > &signal)
	Processes a signal block through the stateful filter.

template<typename Container > requires Is_Real_Container<Container>
Array< Real >	filter (const Container &signal)
	Processes a real-valued container through the stateful filter.

Private Member Functions
void	require_configured (const char *ctx) const

void	initialize_state ()

Private Attributes
IIRCoefficients	coeffs_

Array< Real >	state_

bool	configured_ = false

Detailed Description

template<std::floating_point Real = double>
class Aleph::FFT< Real >::LFilter

Stateful direct-form II transposed IIR filter.

Definition at line 11462 of file fft.H.

Constructor & Destructor Documentation

◆ LFilter() [1/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::LFilter::LFilter ( )

default

Default constructor for an unconfigured LFilter.

◆ LFilter() [2/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::LFilter::LFilter	(	const Array< Real > &	numerator,
		const Array< Real > &	denominator
	)

inlineexplicit

Construct a linear filter from numerator and denominator arrays.

The filter is normalized such that a[0] = 1.

Parameters

numerator	Feed-forward coefficients (B).
denominator	Feed-back coefficients (A).

Definition at line 11495 of file fft.H.

References Aleph::FFT< Real >::LFilter::initialize_state().

◆ LFilter() [3/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::LFilter::LFilter ( const IIRCoefficients & coeffs )

inlineexplicit

Construct a linear filter from IIRCoefficients.

Parameters

coeffs IIR coefficients.

Definition at line 11507 of file fft.H.

◆ LFilter() [4/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::LFilter::LFilter ( const BiquadSection & section )

inlineexplicit

Construct a linear filter from a single BiquadSection.

Parameters

section Biquad section.

Definition at line 11513 of file fft.H.

◆ LFilter() [5/5]

template<std::floating_point Real = double>

template<typename NumContainer , typename DenContainer >
requires Is_Real_Container<NumContainer>

and Is_Real_Container< DenContainer > Aleph::FFT< Real >::LFilter::LFilter	(	const NumContainer &	numerator,
		const DenContainer &	denominator
	)

inlineexplicit

Construct a linear filter from any real containers.

Template Parameters

NumContainer	Type for numerator.
DenContainer	Type for denominator.

Parameters

numerator	Feed-forward coefficients.
denominator	Feed-back coefficients.

Definition at line 11526 of file fft.H.

Member Function Documentation

◆ coefficients()

template<std::floating_point Real = double>

const IIRCoefficients & Aleph::FFT< Real >::LFilter::coefficients ( ) const

inlinenoexcept

Returns the active normalized filter coefficients.

Definition at line 11544 of file fft.H.

References Aleph::FFT< Real >::LFilter::coeffs_.

◆ configured()

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::LFilter::configured ( ) const

inlinenoexcept

Returns whether the filter has been initialized with coefficients.

Definition at line 11538 of file fft.H.

References Aleph::FFT< Real >::LFilter::configured_.

◆ filter() [1/2]

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::LFilter::filter ( const Array< Real > & signal )

inline

Processes a signal block through the stateful filter.

Definition at line 11575 of file fft.H.

References Aleph::FFT< Real >::LFilter::coeffs_, Aleph::FFT< Real >::IIRCoefficients::denominator, Aleph::FFT< Real >::iir_filter_impl(), Aleph::FFT< Real >::IIRCoefficients::numerator, Aleph::FFT< Real >::LFilter::require_configured(), and Aleph::FFT< Real >::LFilter::state_.

Referenced by Aleph::FFT< Real >::LFilter::filter(), Aleph::FFT< Real >::LFilterBank::filter_channel(), and Aleph::FFT< Real >::LFilterBank::filter_channel().

◆ filter() [2/2]

template<std::floating_point Real = double>

template<typename Container >
requires Is_Real_Container<Container>

Array< Real > Aleph::FFT< Real >::LFilter::filter ( const Container & signal )

inline

Processes a real-valued container through the stateful filter.

Definition at line 11590 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::LFilter::filter().

◆ initialize_state()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::LFilter::initialize_state ( )

inlineprivate

Definition at line 11476 of file fft.H.

References Aleph::FFT< Real >::LFilter::coeffs_, Aleph::Array< T >::create(), Aleph::FFT< Real >::IIRCoefficients::denominator, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::LFilter::order(), Aleph::Array< T >::size(), and Aleph::FFT< Real >::LFilter::state_.

Referenced by Aleph::FFT< Real >::LFilter::LFilter().

◆ order()

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::LFilter::order ( ) const

inlinenoexcept

Returns the filter order (number of feedback coefficients - 1).

Definition at line 11532 of file fft.H.

References Aleph::FFT< Real >::LFilter::coeffs_, Aleph::FFT< Real >::IIRCoefficients::denominator, Aleph::Array< T >::is_empty(), and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::LFilter::initialize_state().

◆ require_configured()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::LFilter::require_configured ( const char * ctx ) const

inlineprivate

Definition at line 11469 of file fft.H.

References ah_runtime_error_if, Aleph::FFT< Real >::LFilter::configured_, and Aleph::divide_and_conquer_partition_dp().

Referenced by Aleph::FFT< Real >::LFilter::filter(), Aleph::FFT< Real >::LFilter::reset(), and Aleph::FFT< Real >::LFilter::set_state().

◆ reset()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::LFilter::reset ( )

inline

Resets the delay-line state to zero.

Definition at line 11556 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::LFilter::require_configured(), Aleph::Array< T >::size(), and Aleph::FFT< Real >::LFilter::state_.

◆ set_state()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::LFilter::set_state ( const Array< Real > & new_state )

inline

Manually overrides the delay-line state.

Definition at line 11564 of file fft.H.

References ah_invalid_argument_if, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::LFilter::require_configured(), Aleph::Array< T >::size(), and Aleph::FFT< Real >::LFilter::state_.

◆ state()

template<std::floating_point Real = double>

const Array< Real > & Aleph::FFT< Real >::LFilter::state ( ) const

inlinenoexcept

Returns the current internal delay-line state.

Definition at line 11550 of file fft.H.

References Aleph::FFT< Real >::LFilter::state_.

Member Data Documentation

◆ coeffs_

template<std::floating_point Real = double>

IIRCoefficients Aleph::FFT< Real >::LFilter::coeffs_

private

Definition at line 11464 of file fft.H.

Referenced by Aleph::FFT< Real >::LFilter::coefficients(), Aleph::FFT< Real >::LFilter::filter(), Aleph::FFT< Real >::LFilter::initialize_state(), and Aleph::FFT< Real >::LFilter::order().

◆ configured_

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::LFilter::configured_ = false

private

Definition at line 11466 of file fft.H.

Referenced by Aleph::FFT< Real >::LFilter::configured(), and Aleph::FFT< Real >::LFilter::require_configured().

◆ state_

template<std::floating_point Real = double>

Array<Real> Aleph::FFT< Real >::LFilter::state_

private

Definition at line 11465 of file fft.H.

Referenced by Aleph::FFT< Real >::LFilter::filter(), Aleph::FFT< Real >::LFilter::initialize_state(), Aleph::FFT< Real >::LFilter::reset(), Aleph::FFT< Real >::LFilter::set_state(), and Aleph::FFT< Real >::LFilter::state().

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

fft.H

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LFilter() [1/5]

◆ LFilter() [2/5]

◆ LFilter() [3/5]

◆ LFilter() [4/5]

◆ LFilter() [5/5]

Member Function Documentation

◆ coefficients()

◆ configured()

◆ filter() [1/2]

◆ filter() [2/2]

◆ initialize_state()

◆ order()

◆ require_configured()

◆ reset()

◆ set_state()

◆ state()

Member Data Documentation

◆ coeffs_

◆ configured_

◆ state_