Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

gr_fir_fsf Class Reference
[Filter Primitives]

#include <gr_fir_fsf.h>

Inheritance diagram for gr_fir_fsf:

Inheritance graph
[legend]
Collaboration diagram for gr_fir_fsf:

Collaboration graph
[legend]
List of all members.

Detailed Description

Abstract class for FIR with float input, short output and float taps.

This is the abstract class for a Finite Impulse Response filter.

The trailing suffix has the form _IOT where I codes the input type, O codes the output type, and T codes the tap type. I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), 'i' (int)


Public Member Functions

 gr_fir_fsf ()
 construct new FIR with given taps.
 gr_fir_fsf (const std::vector< float > &taps)
virtual ~gr_fir_fsf ()
virtual short filter (const float input[])=0
 compute a single output value.
virtual void filterN (short output[], const float input[], unsigned long n)=0
 compute an array of N output values.
virtual void filterNdec (short output[], const float input[], unsigned long n, unsigned decimate)=0
 compute an array of N output values, decimating the input
virtual void set_taps (const std::vector< float > &taps)
 install new_taps as the current taps.
unsigned ntaps () const
virtual const std::vector<
float > 		get_taps () const

Protected Attributes

std::vector< float > d_taps

Constructor & Destructor Documentation

gr_fir_fsf::gr_fir_fsf (   )  [inline]
 

construct new FIR with given taps.

Note that taps must be in forward order, e.g., coefficient 0 is stored in new_taps[0], coefficient 1 is stored in new_taps[1], etc.

gr_fir_fsf::gr_fir_fsf (  const std::vector< float > &  taps  )  [inline]
 

gr_fir_fsf::~gr_fir_fsf (   )  [virtual]
 

Member Function Documentation

virtual short gr_fir_fsf::filter (  const float  input[]  )  [pure virtual]
 

compute a single output value.

input must have ntaps() valid entries. input[0] .. input[ntaps() - 1] are referenced to compute the output value.

Returns:
the filtered input value.

Implemented in gr_fir_fsf_generic, and gr_fir_fsf_simd.

virtual void gr_fir_fsf::filterN (  short  output[],
const float  input[],
unsigned long  n
)  [pure virtual]
 

compute an array of N output values.

input must have (n - 1 + ntaps()) valid entries. input[0] .. input[n - 1 + ntaps() - 1] are referenced to compute the output values.

Implemented in gr_fir_fsf_generic.

virtual void gr_fir_fsf::filterNdec (  short  output[],
const float  input[],
unsigned long  n,
unsigned  decimate
)  [pure virtual]
 

compute an array of N output values, decimating the input

input must have (decimate * (n - 1) + ntaps()) valid entries. input[0] .. input[decimate * (n - 1) + ntaps() - 1] are referenced to compute the output values.

Implemented in gr_fir_fsf_generic.

virtual const std::vector<float> gr_fir_fsf::get_taps (   )  const [inline, virtual]
 

Returns:
current taps

unsigned gr_fir_fsf::ntaps (   )  const [inline]
 

Returns:
number of taps in filter.

virtual void gr_fir_fsf::set_taps (  const std::vector< float > &  taps  )  [inline, virtual]
 

install new_taps as the current taps.

Reimplemented in gr_fir_fsf_simd.

Member Data Documentation

std::vector<float> gr_fir_fsf::d_taps [protected]
 

The documentation for this class was generated from the following files:
Generated on Sat Jul 8 17:12:28 2006 for GNU Radio 2.x by  doxygen 1.4.1