1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-10-31 23:33:03 +00:00

Improving documentation

git-svn-id: https://svn.code.sf.net/p/gnss-sdr/code/trunk@102 64b25241-fba3-4117-9849-534c7e92360d
This commit is contained in:
Carles Fernandez
2011-12-28 03:05:37 +00:00
parent 0cee2be18f
commit 48719c3075
48 changed files with 261 additions and 324 deletions

View File

@@ -33,13 +33,11 @@
* -------------------------------------------------------------------------
*/
#ifndef GPS_L1_CA_DLL_FLL_PLL_TRACKING_H_
#define GPS_L1_CA_DLL_FLL_PLL_TRACKING_H_
#ifndef GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_H_
#define GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_H_
#include "tracking_interface.h"
#include "gps_l1_ca_dll_fll_pll_tracking_cc.h"
#include <gnuradio/gr_msg_queue.h>
class ConfigurationInterface;

View File

@@ -33,18 +33,18 @@
* -------------------------------------------------------------------------
*/
#ifndef GPS_L1_CA_DLL_PLL_TRACKING_H_
#define GPS_L1_CA_DLL_PLL_TRACKING_H_
#ifndef GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_H_
#define GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_H_
#include "tracking_interface.h"
#include "gps_l1_ca_dll_pll_tracking_cc.h"
#include <gnuradio/gr_msg_queue.h>
class ConfigurationInterface;
/*!
* \brief This class implements a code DLL + carrier PLL tracking loop
*/
class GpsL1CaDllPllTracking : public TrackingInterface
{
@@ -101,4 +101,4 @@ private:
concurrent_queue<int> *channel_internal_queue_;
};
#endif // GPS_L1_CA_DLL_PLL_TRACKING_H_
#endif // GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_H_

View File

@@ -34,18 +34,15 @@
* -------------------------------------------------------------------------
*/
#ifndef GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#define GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#ifndef GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#define GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#include <fstream>
#include <gnuradio/gr_block.h>
#include <gnuradio/gr_msg_queue.h>
//#include <gnuradio/gr_sync_decimator.h>
#include "gps_sdr_signal_processing.h"
#include "tracking_FLL_PLL_filter.h"
#include <queue>
#include <boost/thread/mutex.hpp>
#include <boost/thread/thread.hpp>
@@ -70,6 +67,10 @@ gps_l1_ca_dll_fll_pll_make_tracking_cc(unsigned int satellite,
float early_late_space_chips);
//class gps_l1_ca_dll_pll_tracking_cc: public gr_sync_decimator
/*!
* \brief This class implements a DLL and a FLL assisted PLL tracking loop block
*/
class gps_l1_ca_dll_fll_pll_tracking_cc: public gr_block
{
@@ -204,4 +205,4 @@ public:
};
#endif //GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#endif //GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H

View File

@@ -47,9 +47,7 @@
#include <sstream>
#include <cmath>
#include "math.h"
#include <gnuradio/gr_io_signature.h>
#include <glog/log_severity.h>
#include <glog/logging.h>

View File

@@ -32,19 +32,16 @@
*
* -------------------------------------------------------------------------
*/
#ifndef GPS_L1_CA_DLL_PLL_TRACKING_CC_H
#define GPS_L1_CA_DLL_PLL_TRACKING_CC_H
#ifndef GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_CC_H
#define GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_CC_H
#include <fstream>
#include <gnuradio/gr_block.h>
#include <gnuradio/gr_msg_queue.h>
//#include <gnuradio/gr_sync_decimator.h>
#include "gps_sdr_signal_processing.h"
#include "tracking_2nd_DLL_filter.h"
#include "tracking_2nd_PLL_filter.h"
#include <queue>
#include <boost/thread/mutex.hpp>
#include <boost/thread/thread.hpp>
@@ -66,6 +63,10 @@ gps_l1_ca_dll_pll_make_tracking_cc(unsigned int satellite, long if_freq,
float early_late_space_chips);
//class gps_l1_ca_dll_pll_tracking_cc: public gr_sync_decimator
/*!
* \brief This class implements a DLL + PLL tracking loop block
*/
class gps_l1_ca_dll_pll_tracking_cc: public gr_block
{
@@ -194,4 +195,4 @@ public:
};
#endif //GPS_L1_CA_DLL_PLL_TRACKING_CC_H
#endif //GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_CC_H

View File

@@ -30,8 +30,8 @@
* -------------------------------------------------------------------------
*/
#ifndef CN_ESTIMATORS_H_
#define CN_ESTIMATORS_H_
#ifndef GNSS_SDR_CN_ESTIMATORS_H_
#define GNSS_SDR_CN_ESTIMATORS_H_
#include <gnuradio/gr_complex.h>

View File

@@ -3,9 +3,8 @@
* \brief Class that implements 2 order DLL filter for code tracking loop.
* \author Javier Arribas, 2011. jarribas(at)cttc.es
*
* Class that implements 2 order PLL filter for code tracking loop. The algorithm is described in [1]
*
* [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Class that implements 2 order PLL filter for code tracking loop. The algorithm is described in:
* K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S. H. Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
*
* -------------------------------------------------------------------------
@@ -33,9 +32,16 @@
* -------------------------------------------------------------------------
*/
#ifndef TRACKING_2ND_DLL_FILTER_H_
#define TRACKING_2ND_DLL_FILTER_H_
#ifndef GNSS_SDR_TRACKING_2ND_DLL_FILTER_H_
#define GNSS_SDR_TRACKING_2ND_DLL_FILTER_H_
/*!
* \brief This class implements a 2nd order DLL filter for code tracking loop.
*
* The algorithm is described in:
* K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S. H. Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
*/
class tracking_2nd_DLL_filter
{
private:
@@ -51,7 +57,7 @@ private:
void calculate_lopp_coef(float* tau1,float* tau2, float lbw, float zeta, float k);
public:
void set_DLL_BW(float dll_bw_hz);
void set_DLL_BW(float dll_bw_hz); //! Set DLL loop bandwidth [Hz]
void initialize(float d_acq_code_phase_samples);
float get_code_nco(float DLL_discriminator);
tracking_2nd_DLL_filter();

View File

@@ -1,11 +1,10 @@
/*!
* \file tracking_2nd_PLL_filter.h
* \brief Class that implements 2 order PLL filter for tracking carrier loop
* \brief Class that implements 2 order PLL filter for carrier tracking loop
* \author Javier Arribas, 2011. jarribas(at)cttc.es
*
* Class that implements 2 order PLL filter for tracking carrier loop. The algorithm is described in [1]
*
* [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Class that implements 2 order PLL filter for tracking carrier loop. The algorithm is described in
* K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
*
* -------------------------------------------------------------------------
@@ -33,9 +32,16 @@
* -------------------------------------------------------------------------
*/
#ifndef TRACKING_2ND_PLL_FILTER_H_
#define TRACKING_2ND_PLL_FILTER_H_
#ifndef GNSS_SDR_TRACKING_2ND_PLL_FILTER_H_
#define GNSS_SDR_TRACKING_2ND_PLL_FILTER_H_
/*!
* \brief This class implements a 2nd order PLL filter for carrier tracking loop.
*
* The algorithm is described in:
* K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S. H. Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
* Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
*/
class tracking_2nd_PLL_filter
{
private:
@@ -52,7 +58,7 @@ private:
void calculate_lopp_coef(float* tau1,float* tau2, float lbw, float zeta, float k);
public:
void set_PLL_BW(float pll_bw_hz);
void set_PLL_BW(float pll_bw_hz); //! Set PLL loop bandwidth [Hz]
void initialize(float d_acq_carrier_doppler_hz);
float get_carrier_nco(float PLL_discriminator);
tracking_2nd_PLL_filter();

View File

@@ -30,9 +30,12 @@
* -------------------------------------------------------------------------
*/
#ifndef TRACKING_FLL_PLL_FILTER_H_
#define TRACKING_FLL_PLL_FILTER_H_
#ifndef GNSS_SDR_TRACKING_FLL_PLL_FILTER_H_
#define GNSS_SDR_TRACKING_FLL_PLL_FILTER_H_
/*!
* \brief This class implements a hybrid FLL and PLL filter for tracking carrier loop
*/
class tracking_FLL_PLL_filter
{
private:

View File

@@ -30,8 +30,8 @@
* -------------------------------------------------------------------------
*/
#ifndef TRACKING_DISCRIMINATORS_H_
#define TRACKING_DISCRIMINATORS_H_
#ifndef GNSS_SDR_TRACKING_DISCRIMINATORS_H_
#define GNSS_SDR_TRACKING_DISCRIMINATORS_H_
#include <gnuradio/gr_complex.h>