gnuradio.gr: Synchronization

gnuradio.gr.pll_carriertracking_cc(float loop_bw, float max_freq, float min_freq) → gr_pll_carriertracking_cc_sptr

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

input: stream of complex; output: stream of 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.

gr_pll_carriertracking_cc_sptr.advance_loop(self, float error)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gr_pll_carriertracking_cc_sptr.frequency_limit(self)

Keep the frequency between d_min_freq and d_max_freq.

This function keeps the frequency between d_min_freq and d_max_freq. If the frequency is greater than d_max_freq, it is set to d_max_freq. If the frequency is less than d_min_freq, it is set to d_min_freq.

This function should be called after advance_loop to keep the frequency in the specified region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_carriertracking_cc_sptr.get_alpha(self) → float

Returns the loop gain alpha.

gr_pll_carriertracking_cc_sptr.get_beta(self) → float

Returns the loop gain beta.

gr_pll_carriertracking_cc_sptr.get_damping_factor(self) → float

Returns the loop damping factor.

gr_pll_carriertracking_cc_sptr.get_frequency(self) → float

Get the Costas loop’s frequency estimate.

gr_pll_carriertracking_cc_sptr.get_loop_bandwidth(self) → float

Returns the loop bandwidth.

gr_pll_carriertracking_cc_sptr.get_phase(self) → float

Get the Costas loop’s phase estimate.

gr_pll_carriertracking_cc_sptr.lock_detector(self) → bool

gr_pll_carriertracking_cc_sptr.phase_wrap(self)

Keep the phase between -2pi and 2pi.

This function keeps the phase between -2pi and 2pi. If the phase is greater than 2pi by d, it wraps around to be -2pi+d; similarly if it is less than -2pi by d, it wraps around to 2pi-d.

This function should be called after advance_loop to keep the phase in a good operating region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_carriertracking_cc_sptr.set_alpha(self, float alpha)

Set the loop gain alpha.

Set’s the loop filter’s alpha gain parameter.

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

gr_pll_carriertracking_cc_sptr.set_beta(self, float beta)

Set the loop gain beta.

Set’s the loop filter’s beta gain parameter.

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

gr_pll_carriertracking_cc_sptr.set_damping_factor(self, float df)

Set the loop damping factor.

Set the loop filter’s damping factor to . 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().

gr_pll_carriertracking_cc_sptr.set_frequency(self, float freq)

Set the Costas loop’s frequency.

Set’s the Costas 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.

gr_pll_carriertracking_cc_sptr.set_lock_threshold(self, float arg0) → float

gr_pll_carriertracking_cc_sptr.set_loop_bandwidth(self, float bw)

Set the loop bandwidth.

Set the loop filter’s bandwidth to . 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().

gr_pll_carriertracking_cc_sptr.set_phase(self, float phase)

Set the Costas loop’s phase.

Set’s the Costas 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.

gr_pll_carriertracking_cc_sptr.squelch_enable(self, bool arg0) → bool

gr_pll_carriertracking_cc_sptr.update_gains(self)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gnuradio.gr.pll_freqdet_cf(float loop_bw, float max_freq, float min_freq) → gr_pll_freqdet_cf_sptr

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

input: stream of complex; output: stream of floats.

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.

gr_pll_freqdet_cf_sptr.advance_loop(self, float error)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gr_pll_freqdet_cf_sptr.frequency_limit(self)

Keep the frequency between d_min_freq and d_max_freq.

This function keeps the frequency between d_min_freq and d_max_freq. If the frequency is greater than d_max_freq, it is set to d_max_freq. If the frequency is less than d_min_freq, it is set to d_min_freq.

This function should be called after advance_loop to keep the frequency in the specified region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_freqdet_cf_sptr.get_alpha(self) → float

Returns the loop gain alpha.

gr_pll_freqdet_cf_sptr.get_beta(self) → float

Returns the loop gain beta.

gr_pll_freqdet_cf_sptr.get_damping_factor(self) → float

Returns the loop damping factor.

gr_pll_freqdet_cf_sptr.get_frequency(self) → float

Get the Costas loop’s frequency estimate.

gr_pll_freqdet_cf_sptr.get_loop_bandwidth(self) → float

Returns the loop bandwidth.

gr_pll_freqdet_cf_sptr.get_phase(self) → float

Get the Costas loop’s phase estimate.

gr_pll_freqdet_cf_sptr.phase_wrap(self)

Keep the phase between -2pi and 2pi.

This function keeps the phase between -2pi and 2pi. If the phase is greater than 2pi by d, it wraps around to be -2pi+d; similarly if it is less than -2pi by d, it wraps around to 2pi-d.

This function should be called after advance_loop to keep the phase in a good operating region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_freqdet_cf_sptr.set_alpha(self, float alpha)

Set the loop gain alpha.

Set’s the loop filter’s alpha gain parameter.

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

gr_pll_freqdet_cf_sptr.set_beta(self, float beta)

Set the loop gain beta.

Set’s the loop filter’s beta gain parameter.

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

gr_pll_freqdet_cf_sptr.set_damping_factor(self, float df)

Set the loop damping factor.

Set the loop filter’s damping factor to . 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().

gr_pll_freqdet_cf_sptr.set_frequency(self, float freq)

Set the Costas loop’s frequency.

Set’s the Costas 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.

gr_pll_freqdet_cf_sptr.set_loop_bandwidth(self, float bw)

Set the loop bandwidth.

Set the loop filter’s bandwidth to . 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().

gr_pll_freqdet_cf_sptr.set_phase(self, float phase)

Set the Costas loop’s phase.

Set’s the Costas 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.

gr_pll_freqdet_cf_sptr.update_gains(self)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gnuradio.gr.pll_refout_cc(float loop_bw, float max_freq, float min_freq) → gr_pll_refout_cc_sptr

Implements a PLL which locks to the input frequency and outputs a carrier

input: stream of complex; output: stream of complex.

This PLL locks onto a [possibly noisy] reference carrier on the input and outputs a clean version which is phase and frequency aligned to it.

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.

gr_pll_refout_cc_sptr.advance_loop(self, float error)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gr_pll_refout_cc_sptr.frequency_limit(self)

Keep the frequency between d_min_freq and d_max_freq.

This function keeps the frequency between d_min_freq and d_max_freq. If the frequency is greater than d_max_freq, it is set to d_max_freq. If the frequency is less than d_min_freq, it is set to d_min_freq.

This function should be called after advance_loop to keep the frequency in the specified region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_refout_cc_sptr.get_alpha(self) → float

Returns the loop gain alpha.

gr_pll_refout_cc_sptr.get_beta(self) → float

Returns the loop gain beta.

gr_pll_refout_cc_sptr.get_damping_factor(self) → float

Returns the loop damping factor.

gr_pll_refout_cc_sptr.get_frequency(self) → float

Get the Costas loop’s frequency estimate.

gr_pll_refout_cc_sptr.get_loop_bandwidth(self) → float

Returns the loop bandwidth.

gr_pll_refout_cc_sptr.get_phase(self) → float

Get the Costas loop’s phase estimate.

gr_pll_refout_cc_sptr.phase_wrap(self)

Keep the phase between -2pi and 2pi.

This function keeps the phase between -2pi and 2pi. If the phase is greater than 2pi by d, it wraps around to be -2pi+d; similarly if it is less than -2pi by d, it wraps around to 2pi-d.

This function should be called after advance_loop to keep the phase in a good operating region. It is set as a separate method in case another way is desired as this is fairly heavy-handed.

gr_pll_refout_cc_sptr.set_alpha(self, float alpha)

Set the loop gain alpha.

Set’s the loop filter’s alpha gain parameter.

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

gr_pll_refout_cc_sptr.set_beta(self, float beta)

Set the loop gain beta.

Set’s the loop filter’s beta gain parameter.

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

gr_pll_refout_cc_sptr.set_damping_factor(self, float df)

Set the loop damping factor.

Set the loop filter’s damping factor to . 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().

gr_pll_refout_cc_sptr.set_frequency(self, float freq)

Set the Costas loop’s frequency.

Set’s the Costas 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.

gr_pll_refout_cc_sptr.set_loop_bandwidth(self, float bw)

Set the loop bandwidth.

Set the loop filter’s bandwidth to . 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().

gr_pll_refout_cc_sptr.set_phase(self, float phase)

Set the Costas loop’s phase.

Set’s the Costas 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.

gr_pll_refout_cc_sptr.update_gains(self)

update the system gains from the loop bandwidth and damping factor

This function updates the system gains based on the loop bandwidth and damping factor of the system. These two factors can be set separately through their own set functions.

gnuradio.gr.pn_correlator_cc(int degree, int mask = 0, int seed = 1) → gr_pn_correlator_cc_sptr

PN code sequential search correlator.

Receives complex baseband signal, outputs complex correlation against reference PN code, one sample per PN code period

gnuradio.gr.simple_correlator(int payload_bytesize) → gr_simple_correlator_sptr

inverse of gr_simple_framer (more or less)

gnuradio.gr.simple_framer(int payload_bytesize) → gr_simple_framer_sptr

add sync field, seq number and command field to payload