Smoother.h

/*
 * Smoother.h
 *
 * (c) 2015 Sofian Audry        :: info(@)sofianaudry(.)com
 * (c) 2015 Thomas O Fredericks :: tof(@)t-o-f(.)info
 *
 * This program 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 of the License, or
 * (at your option) any later version.
 *
 * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SMOOTHER_H_
#define SMOOTHER_H_
 
#include "PqCore.h"
#include "MovingFilter.h"
 
namespace pq {

class Smoother : public MovingFilter {
public:
  Smoother(Engine& engine = Engine::primary());

  Smoother(float timeWindow, Engine& engine = Engine::primary());
  virtual ~Smoother() {}

  virtual void reset();

  virtual void reset(float estimatedMeanValue);

  virtual void reset(float estimatedMinValue, float estimatedMaxValue);

  virtual float put(float value);

  virtual float filter(float value);
 
protected:
  virtual void step();
 
  // Variables used to compute current value average during a step (in case of multiple calls to put()).
  float _currentValueStep;
};
 
}
 
#endif