fft_burst_tagger.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2020 Free Software Foundation, Inc.
 *
 * 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_IRIDIUM_FFT_BURST_TAGGER_H
#define INCLUDED_IRIDIUM_FFT_BURST_TAGGER_H
 
#include <gnuradio/sync_block.h>
#include <iridium/api.h>
 
namespace gr {
namespace iridium {
 
/*!
 * \brief <+description of block+>
 * \ingroup iridium
 *
 */
class IRIDIUM_API fft_burst_tagger : virtual public gr::sync_block
{
public:
    typedef std::shared_ptr<fft_burst_tagger> sptr;
 
    /*!
     * \brief Return a shared_ptr to a new instance of iridium::fft_burst_tagger.
     *
     * To avoid accidental use of raw pointers, iridium::fft_burst_tagger's
     * constructor is in a private implementation
     * class. iridium::fft_burst_tagger::make is the public interface for
     * creating new instances.
     */
    static sptr make(double center_frequency,
                     int fft_size,
                     int sample_rate,
                     int burst_pre_len,
                     int burst_post_len,
                     int burst_width,
                     int max_bursts = 0,
                     int max_burst_len = 0,
                     float threshold = 7,
                     int history_size = 512,
                     bool offline = false,
                     bool debug = false);
 
    virtual uint64_t get_n_tagged_bursts() = 0;
    virtual uint64_t get_sample_count() = 0;
};
 
} // namespace iridium
} // namespace gr
 
#endif /* INCLUDED_IRIDIUM_FFT_BURST_TAGGER_H */