Stateful cascade of second-order sections. More...

#include <fft.H>

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

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

	SOSFilter (const Array< BiquadSection > &sections)
	Construct a cascade of second-order sections (SOS).

template<typename SectionsContainer > requires Is_Biquad_Container<SectionsContainer>
	SOSFilter (const SectionsContainer &sections)
	Construct a cascade of SOS from any biquad container.

size_t	num_sections () const noexcept
	Returns the number of sections in the cascade.

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

const Array< Real > &	state (const size_t index) const
	Returns the current delay-line state of section `index`.

void	reset ()
	Resets all internal delay lines to zero.

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

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

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

void	initialize_states ()

Private Attributes
Array< BiquadSection >	sections_

Array< IIRCoefficients >	coeffs_

Array< Array< Real > >	states_

bool	configured_ = false

Detailed Description

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

Stateful cascade of second-order sections.

Definition at line 11597 of file fft.H.

Constructor & Destructor Documentation

◆ SOSFilter() [1/3]

template<std::floating_point Real = double>

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

default

Default constructor for an unconfigured SOSFilter.

◆ SOSFilter() [2/3]

template<std::floating_point Real = double>

Aleph::FFT< Real >::SOSFilter::SOSFilter ( const Array< BiquadSection > & sections )

inlineexplicit

Construct a cascade of second-order sections (SOS).

Parameters

sections Array of biquad sections.

Definition at line 11631 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::SOSFilter::coeffs_, Aleph::FFT< Real >::SOSFilter::initialize_states(), Aleph::FFT< Real >::normalize_iir_coefficients(), and Aleph::FFT< Real >::SOSFilter::sections_.

◆ SOSFilter() [3/3]

template<std::floating_point Real = double>

template<typename SectionsContainer >
requires Is_Biquad_Container<SectionsContainer>

Aleph::FFT< Real >::SOSFilter::SOSFilter ( const SectionsContainer & sections )

inlineexplicit

Construct a cascade of SOS from any biquad container.

Template Parameters

SectionsContainer Container of BiquadSection.

Parameters

sections Biquad sections.

Definition at line 11651 of file fft.H.

Member Function Documentation

◆ configured()

template<std::floating_point Real = double>

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

inlinenoexcept

Returns whether the filter has been configured.

Definition at line 11662 of file fft.H.

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

◆ filter() [1/2]

template<std::floating_point Real = double>

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

inline

Processes a signal block through the stateful SOS cascade.

Definition at line 11688 of file fft.H.

References Aleph::FFT< Real >::SOSFilter::coeffs_, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::iir_filter_impl(), Aleph::FFT< Real >::SOSFilter::require_configured(), and Aleph::FFT< Real >::SOSFilter::states_.

Referenced by Aleph::FFT< Real >::SOSFilter::filter(), Aleph::FFT< Real >::SOSFilterBank::filter_channel(), Aleph::FFT< Real >::SOSFilterBank::filter_channel(), and Aleph::FFT< Real >::sosfilt().

◆ filter() [2/2]

template<std::floating_point Real = double>

template<typename Container >
requires Is_Real_Container<Container>

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

inline

Processes a real-valued container through the stateful SOS cascade.

Definition at line 11710 of file fft.H.

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

◆ initialize_states()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::SOSFilter::initialize_states ( )

inlineprivate

Definition at line 11612 of file fft.H.

References Aleph::FFT< Real >::SOSFilter::coeffs_, Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::Array< T >::size(), Aleph::FFT< Real >::SOSFilter::state(), and Aleph::FFT< Real >::SOSFilter::states_.

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

◆ num_sections()

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::SOSFilter::num_sections ( ) const

inlinenoexcept

Returns the number of sections in the cascade.

Definition at line 11656 of file fft.H.

References Aleph::FFT< Real >::SOSFilter::sections_.

◆ require_configured()

template<std::floating_point Real = double>

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

inlineprivate

Definition at line 11605 of file fft.H.

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

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

◆ reset()

template<std::floating_point Real = double>

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

inline

Resets all internal delay lines to zero.

Definition at line 11678 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::SOSFilter::require_configured(), and Aleph::FFT< Real >::SOSFilter::states_.

◆ state()

template<std::floating_point Real = double>

const Array< Real > & Aleph::FFT< Real >::SOSFilter::state ( const size_t index ) const

inline

Returns the current delay-line state of section index.

Definition at line 11669 of file fft.H.

References ah_out_of_range_error_if, Aleph::Array< T >::size(), and Aleph::FFT< Real >::SOSFilter::states_.

Referenced by Aleph::FFT< Real >::SOSFilter::initialize_states().

Member Data Documentation

◆ coeffs_

template<std::floating_point Real = double>

Array<IIRCoefficients> Aleph::FFT< Real >::SOSFilter::coeffs_

private

Definition at line 11600 of file fft.H.

Referenced by Aleph::FFT< Real >::SOSFilter::SOSFilter(), Aleph::FFT< Real >::SOSFilter::filter(), and Aleph::FFT< Real >::SOSFilter::initialize_states().

◆ configured_

template<std::floating_point Real = double>

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

private

Definition at line 11602 of file fft.H.

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

◆ sections_

template<std::floating_point Real = double>

Array<BiquadSection> Aleph::FFT< Real >::SOSFilter::sections_

private

Definition at line 11599 of file fft.H.

Referenced by Aleph::FFT< Real >::SOSFilter::SOSFilter(), and Aleph::FFT< Real >::SOSFilter::num_sections().

◆ states_

template<std::floating_point Real = double>

Array<Array<Real> > Aleph::FFT< Real >::SOSFilter::states_

private

Definition at line 11601 of file fft.H.

Referenced by Aleph::FFT< Real >::SOSFilter::filter(), Aleph::FFT< Real >::SOSFilter::initialize_states(), Aleph::FFT< Real >::SOSFilter::reset(), and Aleph::FFT< Real >::SOSFilter::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

◆ SOSFilter() [1/3]

◆ SOSFilter() [2/3]

◆ SOSFilter() [3/3]

Member Function Documentation

◆ configured()

◆ filter() [1/2]

◆ filter() [2/2]

◆ initialize_states()

◆ num_sections()

◆ require_configured()

◆ reset()

◆ state()

Member Data Documentation

◆ coeffs_

◆ configured_

◆ sections_

◆ states_