GNU Radio Radar Toolbox
estimator_cw.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 Communications Engineering Lab, KIT.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef INCLUDED_RADAR_ESTIMATOR_CW_H
22 #define INCLUDED_RADAR_ESTIMATOR_CW_H
23 
24 #include <gnuradio/sync_block.h>
25 #include <radar/api.h>
26 
27 namespace gr {
28 namespace radar {
29 
30 /*!
31  * \brief This block estimates the velocity from given peaks of a CW spectrum. The
32  * estimator looks for a f32vector tagged with a 'frequency' identifier (symbol) and
33  * calculates the velocity with the doppler formula. The identifier (symbol) of the output
34  * data is 'velocity'. Needed identifier (symbols) of the input are 'frequency'.
35  *
36  * \param center_freq Center frequency
37  *
38  * \ingroup radar
39  *
40  */
41 class RADAR_API estimator_cw : virtual public gr::block
42 {
43 public:
44  typedef boost::shared_ptr<estimator_cw> sptr;
45 
46  /*!
47  * \brief Return a shared_ptr to a new instance of radar::estimator_cw.
48  *
49  * To avoid accidental use of raw pointers, radar::estimator_cw's
50  * constructor is in a private implementation
51  * class. radar::estimator_cw::make is the public interface for
52  * creating new instances.
53  */
54  static sptr make(float center_freq);
55 };
56 
57 } // namespace radar
58 } // namespace gr
59 
60 #endif /* INCLUDED_RADAR_ESTIMATOR_CW_H */
#define RADAR_API
Definition: api.h:31
This block estimates the velocity from given peaks of a CW spectrum. The estimator looks for a f32vec...
Definition: estimator_cw.h:42
boost::shared_ptr< estimator_cw > sptr
Definition: estimator_cw.h:44
static sptr make(float center_freq)
Return a shared_ptr to a new instance of radar::estimator_cw.
Definition: crop_matrix_vcvc.h:28