GNU Radio C++ API Reference 3.10.11.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
gr::filter::single_pole_iir< gr_complex, i_type, double > Class Template Reference

#include <gnuradio/filter/single_pole_iir.h>

Public Member Functions

 single_pole_iir (double alpha=1.0)
 construct new single pole IIR with given alpha
 
gr_complex filter (const i_type input)
 compute a single output value.
 
void filterN (gr_complex output[], const i_type input[], unsigned long n)
 compute an array of N output values. input must have n valid entries.
 
void set_taps (double alpha)
 install alpha as the current taps.
 
void reset ()
 reset state to zero
 
gr_complexd prev_output () const
 
 single_pole_iir (double alpha=1.0)
 construct new single pole IIR with given alpha
 
gr_complex filter (const i_type input)
 compute a single output value.
 
void filterN (gr_complex output[], const i_type input[], unsigned long n)
 compute an array of N output values. input must have n valid entries.
 
void set_taps (double alpha)
 install alpha as the current taps.
 
void reset ()
 reset state to zero
 
gr_complex prev_output () const
 

Protected Attributes

double d_alpha
 
double d_one_minus_alpha
 
gr_complexd d_prev_output
 
double d_alpha
 
double d_one_minus_alpha
 
gr_complex d_prev_output
 

Constructor & Destructor Documentation

◆ single_pole_iir() [1/2]

template<class i_type>
gr::filter::single_pole_iir< gr_complex, i_type, double >::single_pole_iir ( double alpha = 1.0)
inline

construct new single pole IIR with given alpha

computes y(i) = (1-alpha) * y(i-1) + alpha * x(i)

References d_prev_output, and gr::filter::single_pole_iir< o_type, i_type, tap_type >::set_taps().

◆ single_pole_iir() [2/2]

gr::filter::single_pole_iir< gr_complex, i_type, double >::single_pole_iir ( double alpha = 1.0)
inline

construct new single pole IIR with given alpha

computes y(i) = (1-alpha) * y(i-1) + alpha * x(i)

Member Function Documentation

◆ filter() [1/2]

gr_complex gr::filter::single_pole_iir< gr_complex, i_type, double >::filter ( const i_type input)

compute a single output value.

Returns
the filtered input value.

◆ filter() [2/2]

template<class i_type>
gr_complex gr::filter::single_pole_iir< gr_complex, i_type, double >::filter ( const i_type input)

compute a single output value.

Returns
the filtered input value.

References d_alpha, d_one_minus_alpha, and d_prev_output.

Referenced by filterN().

◆ filterN() [1/2]

void gr::filter::single_pole_iir< gr_complex, i_type, double >::filterN ( gr_complex output[],
const i_type input[],
unsigned long n )

compute an array of N output values. input must have n valid entries.

◆ filterN() [2/2]

template<class i_type>
void gr::filter::single_pole_iir< gr_complex, i_type, double >::filterN ( gr_complex output[],
const i_type input[],
unsigned long n )

compute an array of N output values. input must have n valid entries.

References filter().

◆ prev_output() [1/2]

gr_complex gr::filter::single_pole_iir< gr_complex, i_type, double >::prev_output ( ) const
inline

◆ prev_output() [2/2]

template<class i_type>
gr_complexd gr::filter::single_pole_iir< gr_complex, i_type, double >::prev_output ( ) const
inline

References d_prev_output.

◆ reset() [1/2]

void gr::filter::single_pole_iir< gr_complex, i_type, double >::reset ( )
inline

reset state to zero

◆ reset() [2/2]

template<class i_type>
void gr::filter::single_pole_iir< gr_complex, i_type, double >::reset ( )
inline

reset state to zero

References d_prev_output.

◆ set_taps() [1/2]

void gr::filter::single_pole_iir< gr_complex, i_type, double >::set_taps ( double alpha)
inline

install alpha as the current taps.

◆ set_taps() [2/2]

template<class i_type>
void gr::filter::single_pole_iir< gr_complex, i_type, double >::set_taps ( double alpha)
inline

install alpha as the current taps.

References d_alpha, and d_one_minus_alpha.

Member Data Documentation

◆ d_alpha [1/2]

double gr::filter::single_pole_iir< gr_complex, i_type, double >::d_alpha
protected

◆ d_alpha [2/2]

template<class i_type>
double gr::filter::single_pole_iir< gr_complex, i_type, double >::d_alpha
protected

Referenced by filter(), and set_taps().

◆ d_one_minus_alpha [1/2]

double gr::filter::single_pole_iir< gr_complex, i_type, double >::d_one_minus_alpha
protected

◆ d_one_minus_alpha [2/2]

template<class i_type>
double gr::filter::single_pole_iir< gr_complex, i_type, double >::d_one_minus_alpha
protected

Referenced by filter(), and set_taps().

◆ d_prev_output [1/2]

gr_complex gr::filter::single_pole_iir< gr_complex, i_type, double >::d_prev_output
protected

◆ d_prev_output [2/2]

template<class i_type>
gr_complexd gr::filter::single_pole_iir< gr_complex, i_type, double >::d_prev_output
protected

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