TimeWindowAverageFilter.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2017, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * 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 program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarX
19  * @author Mirko Waechter (mirko.waechter at kit dot edu)
20  * @date 2019
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 
25 #pragma once
26 
27 #include "RTFilterBase.h"
28 
29 namespace armarx::rtfilters
30 {
31 
32  /**
33  * @brief This filters allows to filter with an unstable frequency by considering only the
34  * valus in a specified timewindow. An average filter is applied to all values in the time window.
35  */
37  {
38  public:
39  TimeWindowAverageFilter(IceUtil::Time timeWindowSize, double maxFrequency);
40 
41  // RTFilterBase interface
42  public:
43  double calculate() override;
44  RTFilterBasePtr clone() const override;
45  private:
46  IceUtil::Time timeWindowSize;
47  };
48 
49 }
armarx::rtfilters::RTFilterBasePtr
std::shared_ptr< RTFilterBase > RTFilterBasePtr
Definition: RTFilterBase.h:34
armarx::rtfilters::TimeWindowAverageFilter::calculate
double calculate() override
Definition: TimeWindowAverageFilter.cpp:35
armarx::rtfilters::TimeWindowAverageFilter
This filters allows to filter with an unstable frequency by considering only the valus in a specified...
Definition: TimeWindowAverageFilter.h:36
armarx::rtfilters
Definition: AverageFilter.cpp:26
armarx::rtfilters::TimeWindowAverageFilter::clone
RTFilterBasePtr clone() const override
Definition: TimeWindowAverageFilter.cpp:70
armarx::rtfilters::RTFilterBase
The RTFilterBase class is the base class for all real time capable filters.
Definition: RTFilterBase.h:40
armarx::armem::Time
armarx::core::time::DateTime Time
Definition: forward_declarations.h:13
armarx::rtfilters::TimeWindowAverageFilter::TimeWindowAverageFilter
TimeWindowAverageFilter(IceUtil::Time timeWindowSize, double maxFrequency)
Definition: TimeWindowAverageFilter.cpp:29
RTFilterBase.h