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::analog::pll_freqdet_cf Class Reference

Implements a PLL which locks to the input frequency and outputs an estimate of that frequency. Useful for FM Demod. More...

#include <gnuradio/analog/pll_freqdet_cf.h>

Public Types

typedef boost::shared_ptr
< pll_freqdet_cf
sptr

Public Member Functions

virtual void set_loop_bandwidth (float bw)=0
 Set the loop bandwidth.
virtual void set_damping_factor (float df)=0
 Set the loop damping factor.
virtual void set_alpha (float alpha)=0
 Set the loop gain alpha.
virtual void set_beta (float beta)=0
 Set the loop gain beta.
virtual void set_frequency (float freq)=0
 Set the control loop's frequency.
virtual void set_phase (float phase)=0
 Set the control loop's phase.
virtual void set_min_freq (float freq)=0
 Set the control loop's minimum frequency.
virtual void set_max_freq (float freq)=0
 Set the control loop's maximum frequency.
virtual float get_loop_bandwidth () const =0
 Returns the loop bandwidth.
virtual float get_damping_factor () const =0
 Returns the loop damping factor.
virtual float get_alpha () const =0
 Returns the loop gain alpha.
virtual float get_beta () const =0
 Returns the loop gain beta.
virtual float get_frequency () const =0
 Get the control loop's frequency estimate.
virtual float get_phase () const =0
 Get the control loop's phase estimate.
virtual float get_min_freq () const =0
 Get the control loop's minimum frequency.
virtual float get_max_freq () const =0
 Get the control loop's maximum frequency.
- Public Member Functions inherited from gr::sync_block
virtual int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
 just like gr::block::general_work, only this arranges to call consume_each for you
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
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.
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.
- 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 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
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
- Public Member Functions inherited from gr::blocks::control_loop
 control_loop (void)
 control_loop (float loop_bw, float max_freq, float min_freq)
virtual ~control_loop ()
void update_gains ()
 Update the system gains from the loop bandwidth and damping factor.
void advance_loop (float error)
 Advance the control loop based on the current gain settings and the inputted error signal.
void phase_wrap ()
 Keep the phase between -2pi and 2pi.
void frequency_limit ()
 Keep the frequency between d_min_freq and d_max_freq.

Static Public Member Functions

static sptr make (float loop_bw, float max_freq, float min_freq)

Additional Inherited Members

- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Member Functions inherited from gr::sync_block
 sync_block (void)
 sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
- 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
- Protected Attributes inherited from gr::blocks::control_loop
float d_phase
float d_freq
float d_max_freq
float d_min_freq
float d_damping
float d_loop_bw
float d_alpha
float d_beta

Detailed Description

Implements a PLL which locks to the input frequency and outputs an estimate of that frequency. Useful for FM Demod.

Input stream 0: complex Output stream 0: float

This PLL locks onto a [possibly noisy] reference carrier on the input and outputs an estimate of that frequency in radians per sample. All settings max_freq and min_freq are in terms of radians per sample, NOT HERTZ. The loop bandwidth determins the lock range and should be set around pi/200 – 2pi/100.

See Also
pll_refout_cc, pll_carriertracking_cc

Member Typedef Documentation

Member Function Documentation

virtual float gr::analog::pll_freqdet_cf::get_alpha ( ) const
pure virtual

Returns the loop gain alpha.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_beta ( ) const
pure virtual

Returns the loop gain beta.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_damping_factor ( ) const
pure virtual

Returns the loop damping factor.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_frequency ( ) const
pure virtual

Get the control loop's frequency estimate.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_loop_bandwidth ( ) const
pure virtual

Returns the loop bandwidth.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_max_freq ( ) const
pure virtual

Get the control loop's maximum frequency.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_min_freq ( ) const
pure virtual

Get the control loop's minimum frequency.

Reimplemented from gr::blocks::control_loop.

virtual float gr::analog::pll_freqdet_cf::get_phase ( ) const
pure virtual

Get the control loop's phase estimate.

Reimplemented from gr::blocks::control_loop.

static sptr gr::analog::pll_freqdet_cf::make ( float  loop_bw,
float  max_freq,
float  min_freq 
)
static
virtual void gr::analog::pll_freqdet_cf::set_alpha ( float  alpha)
pure virtual

Set the loop gain alpha.

Sets the loop filter's alpha gain parameter.

This value should really only be set by adjusting the loop bandwidth and damping factor.

Parameters
alpha(float) new alpha gain

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_beta ( float  beta)
pure virtual

Set the loop gain beta.

Sets the loop filter's beta gain parameter.

This value should really only be set by adjusting the loop bandwidth and damping factor.

Parameters
beta(float) new beta gain

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_damping_factor ( float  df)
pure virtual

Set the loop damping factor.

Set the loop filter's damping factor to df. The damping factor should be sqrt(2)/2.0 for critically damped systems. Set it to anything else only if you know what you are doing. It must be a number between 0 and 1.

When a new damping factor is set, the gains, alpha and beta, of the loop are recalculated by a call to update_gains().

Parameters
df(float) new damping factor

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_frequency ( float  freq)
pure virtual

Set the control loop's frequency.

Sets the control loop's frequency. While this is normally updated by the inner loop of the algorithm, it could be useful to manually initialize, set, or reset this under certain circumstances.

Parameters
freq(float) new frequency

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_loop_bandwidth ( float  bw)
pure virtual

Set the loop bandwidth.

Set the loop filter's bandwidth to bw. This should be between 2*pi/200 and 2*pi/100 (in rads/samp). It must also be a positive number.

When a new damping factor is set, the gains, alpha and beta, of the loop are recalculated by a call to update_gains().

Parameters
bw(float) new bandwidth

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_max_freq ( float  freq)
pure virtual

Set the control loop's maximum frequency.

Set the maximum frequency the control loop can track.

Parameters
freq(float) new max frequency

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_min_freq ( float  freq)
pure virtual

Set the control loop's minimum frequency.

Set the minimum frequency the control loop can track.

Parameters
freq(float) new min frequency

Reimplemented from gr::blocks::control_loop.

virtual void gr::analog::pll_freqdet_cf::set_phase ( float  phase)
pure virtual

Set the control loop's phase.

Sets the control loop's phase. While this is normally updated by the inner loop of the algorithm, it could be useful to manually initialize, set, or reset this under certain circumstances.

Parameters
phase(float) new phase

Reimplemented from gr::blocks::control_loop.


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