gr::analog::pll_carriertracking_cc Class Reference

Implements a PLL which locks to the input frequency and outputs the input signal mixed with that carrier. More...

#include <gnuradio/analog/pll_carriertracking_cc.h>

Inheritance diagram for gr::analog::pll_carriertracking_cc:

Public Types
typedef boost::shared_ptr < pll_carriertracking_cc >	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 bool	lock_detector (void)=0
virtual bool	squelch_enable (bool)=0
virtual float	set_lock_threshold (float)=0
virtual void	set_loop_bandwidth (float bw)=0
	Set the loop bandwidth. More...
virtual void	set_damping_factor (float df)=0
virtual void	set_alpha (float alpha)=0
virtual void	set_beta (float beta)=0
virtual void	set_frequency (float freq)=0
virtual void	set_phase (float phase)=0
virtual void	set_min_freq (float freq)=0
virtual void	set_max_freq (float freq)=0
virtual float	get_loop_bandwidth () const =0
virtual float	get_damping_factor () const =0
virtual float	get_alpha () const =0
virtual float	get_beta () const =0
virtual float	get_frequency () const =0
virtual float	get_phase () const =0
virtual float	get_min_freq () const =0
virtual float	get_max_freq () const =0
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 More...
void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request. More...
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 More...
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. More...
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. More...
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. More...
virtual bool	start ()
	Called to enable drivers, etc for i/o devices. More...
virtual bool	stop ()
	Called to disable drivers, etc for i/o devices. More...
void	set_output_multiple (int multiple)
	Constrain the noutput_items argument passed to forecast and general_work. More...
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) More...
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. More...
void	consume_each (int how_many_items)
	Tell the scheduler how_many_items were consumed on each input stream. More...
void	produce (int which_output, int how_many_items)
	Tell the scheduler how_many_items were produced on output stream which_output. More...
void	set_relative_rate (double relative_rate)
	Set the approximate output rate / input rate. More...
double	relative_rate () const
	return the approximate output rate / input rate More...
uint64_t	nitems_read (unsigned int which_input)
	Return the number of items read on input stream which_input. More...
uint64_t	nitems_written (unsigned int which_output)
	Return the number of items written on output stream which_output. More...
tag_propagation_policy_t	tag_propagation_policy ()
	Asks for the policy used by the scheduler to moved tags downstream. More...
void	set_tag_propagation_policy (tag_propagation_policy_t p)
	Set the policy by the scheduler to determine how tags are moved downstream. More...
int	min_noutput_items () const
	Return the minimum number of output items this block can produce during a call to work. More...
void	set_min_noutput_items (int m)
	Set the minimum number of output items this block can produce during a call to work. More...
int	max_noutput_items ()
	Return the maximum number of output items this block will handle during a call to work. More...
void	set_max_noutput_items (int m)
	Set the maximum number of output items this block will handle during a call to work. More...
void	unset_max_noutput_items ()
	Clear the switch for using the max_noutput_items value of this block. More...
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. More...
void	expand_minmax_buffer (int port)
long	max_output_buffer (size_t i)
	Returns max buffer size on output port i. More...
void	set_max_output_buffer (long max_output_buffer)
	Sets max buffer size on all output ports. More...
void	set_max_output_buffer (int port, long max_output_buffer)
	Sets max buffer size on output port port. More...
long	min_output_buffer (size_t i)
	Returns min buffer size on output port i. More...
void	set_min_output_buffer (long min_output_buffer)
	Sets min buffer size on all output ports. More...
void	set_min_output_buffer (int port, long min_output_buffer)
	Sets min buffer size on output port port. More...
float	pc_noutput_items ()
	Gets instantaneous noutput_items performance counter. More...
float	pc_noutput_items_avg ()
	Gets average noutput_items performance counter. More...
float	pc_noutput_items_var ()
	Gets variance of noutput_items performance counter. More...
float	pc_nproduced ()
	Gets instantaneous num items produced performance counter. More...
float	pc_nproduced_avg ()
	Gets average num items produced performance counter. More...
float	pc_nproduced_var ()
	Gets variance of num items produced performance counter. More...
float	pc_input_buffers_full (int which)
	Gets instantaneous fullness of which input buffer. More...
float	pc_input_buffers_full_avg (int which)
	Gets average fullness of which input buffer. More...
float	pc_input_buffers_full_var (int which)
	Gets variance of fullness of which input buffer. More...
std::vector< float >	pc_input_buffers_full ()
	Gets instantaneous fullness of all input buffers. More...
std::vector< float >	pc_input_buffers_full_avg ()
	Gets average fullness of all input buffers. More...
std::vector< float >	pc_input_buffers_full_var ()
	Gets variance of fullness of all input buffers. More...
float	pc_output_buffers_full (int which)
	Gets instantaneous fullness of which input buffer. More...
float	pc_output_buffers_full_avg (int which)
	Gets average fullness of which input buffer. More...
float	pc_output_buffers_full_var (int which)
	Gets variance of fullness of which input buffer. More...
std::vector< float >	pc_output_buffers_full ()
	Gets instantaneous fullness of all output buffers. More...
std::vector< float >	pc_output_buffers_full_avg ()
	Gets average fullness of all output buffers. More...
std::vector< float >	pc_output_buffers_full_var ()
	Gets variance of fullness of all output buffers. More...
float	pc_work_time ()
	Gets instantaneous clock cycles spent in work. More...
float	pc_work_time_avg ()
	Gets average clock cycles spent in work. More...
float	pc_work_time_var ()
	Gets average clock cycles spent in work. More...
float	pc_work_time_total ()
	Gets total clock cycles spent in work. More...
void	reset_perf_counters ()
	Resets the performance counters. More...
void	setup_pc_rpc ()
	Sets up export of perf. counters to ControlPort. Only called by the scheduler. More...
bool	is_pc_rpc_set ()
	Checks if this block is already exporting perf. counters to ControlPort. More...
void	no_pc_rpc ()
	If the block calls this in its constructor, it's perf. counters will not be exported. More...
void	set_processor_affinity (const std::vector< int > &mask)
	Set the thread's affinity to processor core n. More...
void	unset_processor_affinity ()
	Remove processor affinity to a specific core. More...
std::vector< int >	processor_affinity ()
	Get the current processor affinity. More...
int	active_thread_priority ()
	Get the current thread priority in use. More...
int	thread_priority ()
	Get the current thread priority stored. More...
int	set_thread_priority (int priority)
	Set the current thread priority. More...
bool	update_rate () const
block_detail_sptr	detail () const
void	set_detail (block_detail_sptr detail)
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. More...
pmt::pmt_t	message_ports_out ()
	Get output message port names. More...
void	_post (pmt::pmt_t which_port, pmt::pmt_t msg)
bool	empty_p (pmt::pmt_t which_port)
	is the queue empty? More...
bool	empty_p ()
bool	empty_handled_p (pmt::pmt_t which_port)
	are all msg ports with handlers empty? More...
bool	empty_handled_p ()
size_t	nmsgs (pmt::pmt_t which_port)
	How many messages in the queue? More...
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)
virtual void	setup_rpc ()
	Set up the RPC registered variables. More...
bool	is_rpc_set ()
	Ask if this block has been registered to the RPC. More...
void	rpc_set ()
	When the block is registered with the RPC, set this. More...
virtual bool	check_topology (int ninputs, int noutputs)
	Confirm that ninputs and noutputs is an acceptable combination. More...
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. More...
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 More...
Public Member Functions inherited from gr::messages::msg_accepter
	msg_accepter ()
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 More...
void	advance_loop (float error)
	Advance the control loop based on the current gain settings and the inputted error signal. More...
void	phase_wrap ()
	Keep the phase between -2pi and 2pi. More...
void	frequency_limit ()
	Keep the frequency between d_min_freq and d_max_freq. More...
void	set_damping_factor (float df)
	Set the loop damping factor. More...
void	set_alpha (float alpha)
	Set the loop gain alpha. More...
void	set_beta (float beta)
	Set the loop gain beta. More...
void	set_frequency (float freq)
	Set the control loop's frequency. More...
void	set_phase (float phase)
	Set the control loop's phase. More...
void	set_max_freq (float freq)
	Set the control loop's maximum frequency. More...
void	set_min_freq (float freq)
	Set the control loop's minimum frequency. More...
float	get_loop_bandwidth () const
	Returns the loop bandwidth. More...
float	get_damping_factor () const
	Returns the loop damping factor. More...
float	get_alpha () const
	Returns the loop gain alpha. More...
float	get_beta () const
	Returns the loop gain beta. More...
float	get_frequency () const
	Get the control loop's frequency estimate. More...
float	get_phase () const
	Get the control loop's phase estimate. More...
float	get_max_freq () const
	Get the control loop's maximum frequency. More...
float	get_min_freq () const
	Get the control loop's minimum frequency. More...

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 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. More...
void	add_item_tag (unsigned int which_output, const tag_t &tag)
	Adds a new tag onto the given output buffer. More...
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. More...
void	remove_item_tag (unsigned int which_input, const tag_t &tag)
	Removes a tag from the given input buffer. More...
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. More...
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. More...
void	enable_update_rate (bool en)
Protected Member Functions inherited from gr::basic_block
	basic_block (void)
	basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
	Protected constructor prevents instantiation by non-derived classes. More...
void	set_input_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...
void	set_output_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...
void	set_color (vcolor color)
	Allow the flowgraph to set for sorting and partitioning. More...
vcolor	color () const
virtual bool	has_msg_handler (pmt::pmt_t which_port)
	Tests if there is a handler attached to port which_port. More...
virtual void	dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg)
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::basic_block
std::string	d_name
gr::io_signature::sptr	d_input_signature
gr::io_signature::sptr	d_output_signature
long	d_unique_id
long	d_symbolic_id
std::string	d_symbol_name
std::string	d_symbol_alias
vcolor	d_color
bool	d_rpc_set
msg_queue_map_t	msg_queue
std::vector< boost::any >	d_rpc_vars
pmt::pmt_t	d_message_subscribers
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 the input signal mixed with that carrier.

Input stream 0: complex Output stream 0: complex

This PLL locks onto a [possibly noisy] reference carrier on the input and outputs that signal, downconverted to DC

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_freqdet_cf, pll_carriertracking_cc

Member Typedef Documentation

typedef boost::shared_ptr<pll_carriertracking_cc> gr::analog::pll_carriertracking_cc::sptr

Member Function Documentation

virtual float gr::analog::pll_carriertracking_cc::get_alpha ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_beta ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_damping_factor ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_frequency ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_loop_bandwidth ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_max_freq ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_min_freq ( ) const

pure virtual

virtual float gr::analog::pll_carriertracking_cc::get_phase ( ) const

pure virtual

virtual bool gr::analog::pll_carriertracking_cc::lock_detector ( void  )

pure virtual

static sptr gr::analog::pll_carriertracking_cc::make ( float  loop_bw, float  max_freq, float  min_freq  )

static

virtual void gr::analog::pll_carriertracking_cc::set_alpha ( float  alpha )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::set_beta ( float  beta )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::set_damping_factor ( float  df )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::set_frequency ( float  freq )

pure virtual

virtual float gr::analog::pll_carriertracking_cc::set_lock_threshold ( float  )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::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_carriertracking_cc::set_max_freq ( float  freq )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::set_min_freq ( float  freq )

pure virtual

virtual void gr::analog::pll_carriertracking_cc::set_phase ( float  phase )

pure virtual

virtual bool gr::analog::pll_carriertracking_cc::squelch_enable ( bool  )

pure virtual

---

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

• pll_carriertracking_cc.h