GNU Radio 3.6.5 C++ API

gr_rational_resampler_base_scc Class Reference

Rational Resampling Polyphase FIR filter with short input, gr_complex output and gr_complex taps. More...

#include <gr_rational_resampler_base_scc.h>

Inheritance diagram for gr_rational_resampler_base_scc:
gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter

List of all members.

Public Member Functions

 ~gr_rational_resampler_base_scc ()
unsigned history () const
void set_history (unsigned history)
unsigned interpolation () const
unsigned decimation () const
void set_taps (const std::vector< gr_complex > &taps)
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items

Friends

GR_CORE_API
gr_rational_resampler_base_scc_sptr 
gr_make_rational_resampler_base_scc (unsigned interpolation, unsigned decimation, const std::vector< gr_complex > &taps)

Detailed Description

Rational Resampling Polyphase FIR filter with short input, gr_complex output and gr_complex taps.


Constructor & Destructor Documentation

gr_rational_resampler_base_scc::~gr_rational_resampler_base_scc ( )

Member Function Documentation

unsigned gr_rational_resampler_base_scc::decimation ( ) const [inline]
void gr_rational_resampler_base_scc::forecast ( int  noutput_items,
gr_vector_int ninput_items_required 
) [virtual]

Estimate input requirements given output request.

Parameters:
noutput_itemsnumber of output items to produce
ninput_items_requirednumber of input items required on each input stream

Given a request to product noutput_items, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.

Reimplemented from gr_block.

int gr_rational_resampler_base_scc::general_work ( int  noutput_items,
gr_vector_int ninput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

compute output items from input items

Parameters:
noutput_itemsnumber of output items to write on each output stream
ninput_itemsnumber of input items available on each input stream
input_itemsvector of pointers to the input items, one entry per input stream
output_itemsvector of pointers to the output items, one entry per output stream
Returns:
number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items

general_work must call consume or consume_each to indicate how many items were consumed on each input stream.

Reimplemented from gr_block.

unsigned gr_rational_resampler_base_scc::history ( ) const [inline]

Assume block computes y_i = f(x_i, x_i-1, x_i-2, x_i-3...) History is the number of x_i's that are examined to produce one y_i. This comes in handy for FIR filters, where we use history to ensure that our input contains the appropriate "history" for the filter. History should be equal to the number of filter taps.

Reimplemented from gr_block.

unsigned gr_rational_resampler_base_scc::interpolation ( ) const [inline]
void gr_rational_resampler_base_scc::set_history ( unsigned  history) [inline]

Reimplemented from gr_block.

References gr_block::history().

void gr_rational_resampler_base_scc::set_taps ( const std::vector< gr_complex > &  taps)

Friends And Related Function Documentation

GR_CORE_API gr_rational_resampler_base_scc_sptr gr_make_rational_resampler_base_scc ( unsigned  interpolation,
unsigned  decimation,
const std::vector< gr_complex > &  taps 
) [friend]

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