GNU Radio 3.5.3.2 C++ API
gr_probe_mpsk_snr_c.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2008 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 #ifndef INCLUDED_GR_PROBE_MPSK_SNR_C_H
00023 #define INCLUDED_GR_PROBE_MPSK_SNR_C_H
00024 
00025 #include <gr_core_api.h>
00026 #include <gr_sync_block.h>
00027 
00028 class gr_probe_mpsk_snr_c;
00029 typedef boost::shared_ptr<gr_probe_mpsk_snr_c> gr_probe_mpsk_snr_c_sptr;
00030 
00031 GR_CORE_API gr_probe_mpsk_snr_c_sptr
00032 gr_make_probe_mpsk_snr_c(double alpha = 0.0001);
00033 
00034 /*!
00035  * Compute the estimate SNR of an MPSK signal using the Squared Signal
00036  * to Noise Variance (SNV) technique.
00037  *
00038  * This technique assumes an AWGN channel.
00039  *
00040  * \param alpha  Mean and variance smoothing filter constant
00041  * \ingroup sink_blk
00042  *
00043  * Compute the running average of the signal mean and noise variance.
00044  * The estimated signal mean, noise variance, and SNR are available
00045  * via accessors.
00046  *
00047  * This SNR estimator is inaccurate below about 7dB SNR.
00048  *
00049  */
00050 class GR_CORE_API gr_probe_mpsk_snr_c : public gr_sync_block
00051 {
00052   double d_alpha;
00053   double d_beta;
00054   double d_signal_mean;
00055   double d_noise_variance;
00056 
00057   // Factory function returning shared pointer of this class
00058   friend GR_CORE_API gr_probe_mpsk_snr_c_sptr
00059   gr_make_probe_mpsk_snr_c(double alpha);
00060 
00061   // Private constructor
00062   gr_probe_mpsk_snr_c(double alpha);
00063 
00064 public:
00065   ~gr_probe_mpsk_snr_c();
00066 
00067   int work (int noutput_items,
00068             gr_vector_const_void_star &input_items,
00069             gr_vector_void_star &output_items);
00070 
00071   // Return the estimated signal mean
00072   double signal_mean() const { return d_signal_mean; }
00073 
00074   // Return the estimated noise variance
00075   double noise_variance() const { return d_noise_variance; }
00076 
00077   // Return the estimated signal-to-noise ratio in decibels
00078   double snr() const;
00079 
00080   void set_alpha(double alpha);
00081 };
00082 
00083 #endif /* INCLUDED_GR_PROBE_MPSK_SNR_C_H */