estimator_sync_pulse_c.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2014 Communications Engineering Lab, KIT.
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H
#define INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H
#include <gnuradio/tagged_stream_block.h>
#include <radar/api.h>
namespace gr {
namespace radar {
/*!
* \brief This block can be used to estimate the shift of a signal on input 1 in relation
* to another on input 2. For example the constant number of delay samples due to
* hardware effect from a signal source can be estimated. The calculation of the shift is
* done by a cross correlation of the input signals. The number of correlations in samples
* is given with num_xcorr. The output message is the number of delay samples with the
* identifier (symbol) 'sync_pulse'. This can be displayed with the 'Print Results' block.
*
* \param num_xcorr Number of cross correlations
* \param len_key Packet length key for tagged stream
*
* \ingroup radar
*
*/
class RADAR_API estimator_sync_pulse_c : virtual public gr::tagged_stream_block
{
public:
typedef std::shared_ptr<estimator_sync_pulse_c> sptr;
/*!
* \brief Return a shared_ptr to a new instance of radar::estimator_sync_pulse_c.
*
* To avoid accidental use of raw pointers, radar::estimator_sync_pulse_c's
* constructor is in a private implementation
* class. radar::estimator_sync_pulse_c::make is the public interface for
* creating new instances.
*/
static sptr make(int num_xcorr, const std::string len_key = "packet_len");
virtual void set_num_xcorr(int num) = 0;
};
} // namespace radar
} // namespace gr
#endif /* INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H */
api.h
RADAR_API
#define RADAR_API
Definition api.h:31
gr::radar::estimator_sync_pulse_c
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
gr::radar::estimator_sync_pulse_c::make
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.
gr::radar::estimator_sync_pulse_c::set_num_xcorr
virtual void set_num_xcorr(int num)=0
gr::radar::estimator_sync_pulse_c::sptr
std::shared_ptr< estimator_sync_pulse_c > sptr
Definition estimator_sync_pulse_c.h:48
gr::radar
Definition crop_matrix_vcvc.h:29
gr
Definition crop_matrix_vcvc.h:28