mirror of https://github.com/gnss-sdr/gnss-sdr
66 lines
2.1 KiB
C++
66 lines
2.1 KiB
C++
/*!
|
|
* \file exponential_smoother.h
|
|
* \brief Class that implements an exponential smoother
|
|
* \authors Carles Fernandez, 2019 cfernandez@cttc.es
|
|
*
|
|
* Class that implements a first-order exponential smoother.
|
|
*
|
|
* -------------------------------------------------------------------------
|
|
*
|
|
* Copyright (C) 2010-2019 (see AUTHORS file for a list of contributors)
|
|
*
|
|
* GNSS-SDR is a software defined Global Navigation
|
|
* Satellite Systems receiver
|
|
*
|
|
* This file is part of GNSS-SDR.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* -------------------------------------------------------------------------
|
|
*/
|
|
|
|
|
|
#ifndef GNSS_SDR_EXPONENTIAL_SMOOTHER_H
|
|
#define GNSS_SDR_EXPONENTIAL_SMOOTHER_H
|
|
|
|
#include <vector>
|
|
|
|
/*! \brief
|
|
* Class that implements a first-order exponential smoother.
|
|
*
|
|
* smoothed_value[k] = alpha * raw + (1-alpha) * smoothed_value[k-1]
|
|
*
|
|
* The length of the initialization can be controlled with
|
|
* set_samples_for_initialization(int num_samples)
|
|
*/
|
|
class Exponential_Smoother
|
|
{
|
|
public:
|
|
Exponential_Smoother(); //!< Constructor
|
|
~Exponential_Smoother() = default; //!< Destructor
|
|
|
|
Exponential_Smoother(Exponential_Smoother&&) = default; //!< Move operator
|
|
Exponential_Smoother& operator=(Exponential_Smoother&& /*other*/) = default; //!< Move assignment operator
|
|
|
|
void set_alpha(float alpha); //!< 0 < alpha < 1. The higher, the most responsive, but more variance. Default value: 0.001
|
|
void set_samples_for_initialization(int num_samples); //!< Number of samples averaged for initialization. Default value: 200
|
|
void reset();
|
|
void set_min_value(float value);
|
|
void set_offset(float offset);
|
|
float smooth(float raw);
|
|
double smooth(double raw);
|
|
|
|
private:
|
|
std::vector<float> init_buffer_;
|
|
float alpha_; // takes value 0.0001 if not set
|
|
float one_minus_alpha_;
|
|
float old_value_;
|
|
float min_value_;
|
|
float offset_;
|
|
int samples_for_initialization_;
|
|
int init_counter_;
|
|
bool initializing_;
|
|
};
|
|
|
|
#endif // GNSS_SDR_EXPONENTIAL_SMOOTHER_H
|