GNU Radio Manual and C++ API Reference  3.7.5
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
gr::filter::pfb_arb_resampler_ccf Class Reference

Polyphase filterbank arbitrary resampler with gr_complex input, gr_complex output and float taps. More...

#include <gnuradio/filter/pfb_arb_resampler_ccf.h>

Public Types

typedef boost::shared_ptr
< pfb_arb_resampler_ccf
sptr
- Public Types inherited from gr::block
enum  { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
 Magic return values from general_work. More...
enum  tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }

Public Member Functions

virtual void set_taps (const std::vector< float > &taps)=0
virtual std::vector
< std::vector< float > > 
taps () const =0
virtual void print_taps ()=0
virtual void set_rate (float rate)=0
virtual void set_phase (float ph)=0
virtual float phase () const =0
virtual unsigned int taps_per_filter () const =0
virtual unsigned int interpolation_rate () const =0
virtual unsigned int decimation_rate () const =0
virtual float fractional_rate () const =0
virtual int group_delay () const =0
virtual float phase_offset (float freq, float fs)=0
- Public Member Functions inherited from gr::block
virtual ~block ()
unsigned history () const
void set_history (unsigned history)
void declare_sample_delay (int which, unsigned delay)
void declare_sample_delay (unsigned delay)
unsigned sample_delay (int which) const
bool fixed_rate () const
 Return true if this block has a fixed input to output rate.
virtual void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
virtual 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
virtual bool start ()
 Called to enable drivers, etc for i/o devices.
virtual bool stop ()
 Called to disable drivers, etc for i/o devices.
void set_output_multiple (int multiple)
 Constrain the noutput_items argument passed to forecast and general_work.
int output_multiple () const
bool output_multiple_set () const
void set_alignment (int multiple)
 Constrains buffers to work on a set item alignment (for SIMD)
int alignment () const
void set_unaligned (int na)
int unaligned () const
void set_is_unaligned (bool u)
bool is_unaligned () const
void consume (int which_input, int how_many_items)
 Tell the scheduler how_many_items of input stream which_input were consumed.
void consume_each (int how_many_items)
 Tell the scheduler how_many_items were consumed on each input stream.
void produce (int which_output, int how_many_items)
 Tell the scheduler how_many_items were produced on output stream which_output.
void set_relative_rate (double relative_rate)
 Set the approximate output rate / input rate.
double relative_rate () const
 return the approximate output rate / input rate
virtual int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
virtual int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
uint64_t nitems_read (unsigned int which_input)
 Return the number of items read on input stream which_input.
uint64_t nitems_written (unsigned int which_output)
 Return the number of items written on output stream which_output.
tag_propagation_policy_t tag_propagation_policy ()
 Asks for the policy used by the scheduler to moved tags downstream.
void set_tag_propagation_policy (tag_propagation_policy_t p)
 Set the policy by the scheduler to determine how tags are moved downstream.
int min_noutput_items () const
 Return the minimum number of output items this block can produce during a call to work.
void set_min_noutput_items (int m)
 Set the minimum number of output items this block can produce during a call to work.
int max_noutput_items ()
 Return the maximum number of output items this block will handle during a call to work.
void set_max_noutput_items (int m)
 Set the maximum number of output items this block will handle during a call to work.
void unset_max_noutput_items ()
 Clear the switch for using the max_noutput_items value of this block.
bool is_set_max_noutput_items ()
 Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work.
void expand_minmax_buffer (int port)
long max_output_buffer (size_t i)
 Returns max buffer size on output port i.
void set_max_output_buffer (long max_output_buffer)
 Sets max buffer size on all output ports.
void set_max_output_buffer (int port, long max_output_buffer)
 Sets max buffer size on output port port.
long min_output_buffer (size_t i)
 Returns min buffer size on output port i.
void set_min_output_buffer (long min_output_buffer)
 Sets min buffer size on all output ports.
void set_min_output_buffer (int port, long min_output_buffer)
 Sets min buffer size on output port port.
float pc_noutput_items ()
 Gets instantaneous noutput_items performance counter.
float pc_noutput_items_avg ()
 Gets average noutput_items performance counter.
float pc_noutput_items_var ()
 Gets variance of noutput_items performance counter.
float pc_nproduced ()
 Gets instantaneous num items produced performance counter.
float pc_nproduced_avg ()
 Gets average num items produced performance counter.
float pc_nproduced_var ()
 Gets variance of num items produced performance counter.
float pc_input_buffers_full (int which)
 Gets instantaneous fullness of which input buffer.
float pc_input_buffers_full_avg (int which)
 Gets average fullness of which input buffer.
float pc_input_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_input_buffers_full ()
 Gets instantaneous fullness of all input buffers.
std::vector< float > pc_input_buffers_full_avg ()
 Gets average fullness of all input buffers.
std::vector< float > pc_input_buffers_full_var ()
 Gets variance of fullness of all input buffers.
float pc_output_buffers_full (int which)
 Gets instantaneous fullness of which input buffer.
float pc_output_buffers_full_avg (int which)
 Gets average fullness of which input buffer.
float pc_output_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_output_buffers_full ()
 Gets instantaneous fullness of all output buffers.
std::vector< float > pc_output_buffers_full_avg ()
 Gets average fullness of all output buffers.
std::vector< float > pc_output_buffers_full_var ()
 Gets variance of fullness of all output buffers.
float pc_work_time ()
 Gets instantaneous clock cycles spent in work.
float pc_work_time_avg ()
 Gets average clock cycles spent in work.
float pc_work_time_var ()
 Gets average clock cycles spent in work.
float pc_work_time_total ()
 Gets total clock cycles spent in work.
void reset_perf_counters ()
 Resets the performance counters.
void setup_pc_rpc ()
 Sets up export of perf. counters to ControlPort. Only called by the scheduler.
bool is_pc_rpc_set ()
 Checks if this block is already exporting perf. counters to ControlPort.
void no_pc_rpc ()
 If the block calls this in its constructor, it's perf. counters will not be exported.
void set_processor_affinity (const std::vector< int > &mask)
 Set the thread's affinity to processor core n.
void unset_processor_affinity ()
 Remove processor affinity to a specific core.
std::vector< int > processor_affinity ()
 Get the current processor affinity.
int active_thread_priority ()
 Get the current thread priority in use.
int thread_priority ()
 Get the current thread priority stored.
int set_thread_priority (int priority)
 Set the current thread priority.
bool update_rate () const
void system_handler (pmt::pmt_t msg)
 the system message handler
bool finished ()
 returns true when execution has completed due to a message connection
block_detail_sptr detail () const
void set_detail (block_detail_sptr detail)
void notify_msg_neighbors ()
 Tell msg neighbors we are finished.
void clear_finished ()
 Make sure we dont think we are finished.
- Public Member Functions inherited from gr::basic_block
pmt::pmt_t message_subscribers (pmt::pmt_t port)
virtual ~basic_block ()
long unique_id () const
long symbolic_id () const
std::string name () const
std::string symbol_name () const
gr::io_signature::sptr input_signature () const
gr::io_signature::sptr output_signature () const
basic_block_sptr to_basic_block ()
bool alias_set ()
std::string alias ()
pmt::pmt_t alias_pmt ()
void set_block_alias (std::string name)
void message_port_register_in (pmt::pmt_t port_id)
void message_port_register_out (pmt::pmt_t port_id)
void message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)
void message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)
void message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)
virtual bool message_port_is_hier (pmt::pmt_t port_id)
virtual bool message_port_is_hier_in (pmt::pmt_t port_id)
virtual bool message_port_is_hier_out (pmt::pmt_t port_id)
pmt::pmt_t message_ports_in ()
 Get input message port names.
pmt::pmt_t message_ports_out ()
 Get output message port names.
void _post (pmt::pmt_t which_port, pmt::pmt_t msg)
bool empty_p (pmt::pmt_t which_port)
 is the queue empty?
bool empty_p ()
bool empty_handled_p (pmt::pmt_t which_port)
 are all msg ports with handlers empty?
bool empty_handled_p ()
size_t nmsgs (pmt::pmt_t which_port)
 How many messages in the queue?
void insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg)
pmt::pmt_t delete_head_nowait (pmt::pmt_t which_port)
pmt::pmt_t delete_head_blocking (pmt::pmt_t which_port)
msg_queue_t::iterator get_iterator (pmt::pmt_t which_port)
void erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)
virtual bool has_msg_port (pmt::pmt_t which_port)
const msg_queue_map_t & get_msg_map (void) const
virtual void setup_rpc ()
 Set up the RPC registered variables.
bool is_rpc_set ()
 Ask if this block has been registered to the RPC.
void rpc_set ()
 When the block is registered with the RPC, set this.
virtual bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
template<typename T >
void set_msg_handler (pmt::pmt_t which_port, T msg_handler)
 Set the callback that is fired when messages are available.
- Public Member Functions inherited from gr::msg_accepter
 msg_accepter ()
 ~msg_accepter ()
void post (pmt::pmt_t which_port, pmt::pmt_t msg)
 send msg to msg_accepter on port which_port

Static Public Member Functions

static sptr make (float rate, const std::vector< float > &taps, unsigned int filter_size=32)

Additional Inherited Members

- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Member Functions inherited from gr::block
 block (void)
 block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
void set_fixed_rate (bool fixed_rate)
void add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
 Adds a new tag onto the given output buffer.
void add_item_tag (unsigned int which_output, const tag_t &tag)
 Adds a new tag onto the given output buffer.
void remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
 Removes a tag from the given input buffer.
void remove_item_tag (unsigned int which_input, const tag_t &tag)
 Removes a tag from the given input buffer.
void get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
 Given a [start,end), returns a vector of all tags in the range.
void get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
 Given a [start,end), returns a vector of all tags in the range with a given key.
void get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end)
 Gets all tags within the relative window of the current call to work.
void get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key)
 Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified key.
void enable_update_rate (bool en)
- Protected Attributes inherited from gr::block
std::vector< long > d_max_output_buffer
std::vector< long > d_min_output_buffer
gr::thread::mutex d_setlock
gr::logger_ptr d_logger
gr::logger_ptr d_debug_logger

Detailed Description

Polyphase filterbank arbitrary resampler with gr_complex input, gr_complex output and float taps.

This block takes in a signal stream and calls gr::filter::kernel::pfb_arb_resampler_ccf to perform arbitrary resampling on the stream.

Output sampling rate is rate * input rate.

Member Typedef Documentation

Member Function Documentation

virtual unsigned int gr::filter::pfb_arb_resampler_ccf::decimation_rate ( ) const
pure virtual

Gets the decimation rate of the filter.

virtual float gr::filter::pfb_arb_resampler_ccf::fractional_rate ( ) const
pure virtual

Gets the fractional rate of the filter.

virtual int gr::filter::pfb_arb_resampler_ccf::group_delay ( ) const
pure virtual

Get the group delay of the filter.

virtual unsigned int gr::filter::pfb_arb_resampler_ccf::interpolation_rate ( ) const
pure virtual

Gets the interpolation rate of the filter.

static sptr gr::filter::pfb_arb_resampler_ccf::make ( float  rate,
const std::vector< float > &  taps,
unsigned int  filter_size = 32 
)
static

Build the polyphase filterbank arbitray resampler.

Parameters
rate(float) Specifies the resampling rate to use
taps(vector/list of floats) The prototype filter to populate the filterbank. The taps should be generated at the filter_size sampling rate.
filter_size(unsigned int) The number of filters in the filter bank. This is directly related to quantization noise introduced during the resampling. Defaults to 32 filters.
virtual float gr::filter::pfb_arb_resampler_ccf::phase ( ) const
pure virtual

Gets the current phase of the resampler in radians (2 to 2pi).

virtual float gr::filter::pfb_arb_resampler_ccf::phase_offset ( float  freq,
float  fs 
)
pure virtual

Calculates the phase offset expected by a sine wave of frequency freq and sampling rate fs (assuming input sine wave has 0 degree phase).

virtual void gr::filter::pfb_arb_resampler_ccf::print_taps ( )
pure virtual

Print all of the filterbank taps to screen.

virtual void gr::filter::pfb_arb_resampler_ccf::set_phase ( float  ph)
pure virtual

Sets the current phase offset in radians (0 to 2pi).

virtual void gr::filter::pfb_arb_resampler_ccf::set_rate ( float  rate)
pure virtual

Sets the resampling rate of the block.

virtual void gr::filter::pfb_arb_resampler_ccf::set_taps ( const std::vector< float > &  taps)
pure virtual

Resets the filterbank's filter taps with the new prototype filter

Parameters
taps(vector/list of floats) The prototype filter to populate the filterbank.
virtual std::vector<std::vector<float> > gr::filter::pfb_arb_resampler_ccf::taps ( ) const
pure virtual

Return a vector<vector<>> of the filterbank taps

virtual unsigned int gr::filter::pfb_arb_resampler_ccf::taps_per_filter ( ) const
pure virtual

Gets the number of taps per filter.


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