GNU Radio Radar Toolbox
estimator_sync_pulse_c.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
22#ifndef INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H
23#define INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H
24
25#include <gnuradio/tagged_stream_block.h>
26#include <radar/api.h>
27
28namespace gr {
29namespace radar {
30
31/*!
32 * \brief This block can be used to estimate the shift of a signal on input 1 in relation
33 * to another on input 2. For example the constant number of delay samples due to
34 * hardware effect from a signal source can be estimated. The calculation of the shift is
35 * done by a cross correlation of the input signals. The number of correlations in samples
36 * is given with num_xcorr. The output message is the number of delay samples with the
37 * identifier (symbol) 'sync_pulse'. This can be displayed with the 'Print Results' block.
38 *
39 * \param num_xcorr Number of cross correlations
40 * \param len_key Packet length key for tagged stream
41 *
42 * \ingroup radar
43 *
44 */
45class RADAR_API estimator_sync_pulse_c : virtual public gr::tagged_stream_block
46{
47public:
48 typedef std::shared_ptr<estimator_sync_pulse_c> sptr;
49
50 /*!
51 * \brief Return a shared_ptr to a new instance of radar::estimator_sync_pulse_c.
52 *
53 * To avoid accidental use of raw pointers, radar::estimator_sync_pulse_c's
54 * constructor is in a private implementation
55 * class. radar::estimator_sync_pulse_c::make is the public interface for
56 * creating new instances.
57 */
58 static sptr make(int num_xcorr, const std::string len_key = "packet_len");
59
60 virtual void set_num_xcorr(int num) = 0;
61};
62
63} // namespace radar
64} // namespace gr
65
66#endif /* INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H */
#define RADAR_API
Definition api.h:31
This block can be used to estimate the shift of a signal on input 1 in relation to another on input 2...
Definition estimator_sync_pulse_c.h:46
static sptr make(int num_xcorr, const std::string len_key="packet_len")
Return a shared_ptr to a new instance of radar::estimator_sync_pulse_c.
virtual void set_num_xcorr(int num)=0
std::shared_ptr< estimator_sync_pulse_c > sptr
Definition estimator_sync_pulse_c.h:48
Definition crop_matrix_vcvc.h:28