TimeWindowAverageFilter.cpp
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  */
25 
26 //#include <ArmarXCore/core/logging/Logging.h>
27 namespace armarx::rtfilters
28 {
29 
31  double maxFrequency) :
32  RTFilterBase(timeWindowSize.toSecondsDouble() * maxFrequency),
33  timeWindowSize(timeWindowSize)
34  {
35  }
36 
37  double
39  {
40  if (dataHistory.empty())
41  {
42  return 0;
43  }
44  IceUtil::Time newestTimestamp = dataHistory.back().first;
45  IceUtil::Time timeBorder = (newestTimestamp - timeWindowSize);
46  double sum = 0;
47  int count = 0;
48  for (auto it = dataHistory.rbegin(); it != dataHistory.rend(); it++)
49  {
50  IceUtil::Time& t = it->first;
51  double val = it->second;
52  if (t > timeBorder)
53  {
54  count++;
55  sum += val;
56  }
57  else
58  {
59  // assume that timestamps are ordered
60  break;
61  }
62  }
63  if (count > 0)
64  {
65  return sum / count;
66  }
67  else
68  {
69  return 0;
70  }
71  }
72 
75  {
76  return std::make_shared<TimeWindowAverageFilter>(*this);
77  }
78 
79 } // namespace armarx::rtfilters
TimeWindowAverageFilter.h
armarx::rtfilters::RTFilterBasePtr
std::shared_ptr< RTFilterBase > RTFilterBasePtr
Definition: RTFilterBase.h:34
armarx::rtfilters::TimeWindowAverageFilter::calculate
double calculate() override
Definition: TimeWindowAverageFilter.cpp:38
armarx::rtfilters
Definition: AverageFilter.cpp:26
armarx::rtfilters::TimeWindowAverageFilter::clone
RTFilterBasePtr clone() const override
Definition: TimeWindowAverageFilter.cpp:74
armarx::rtfilters::RTFilterBase::dataHistory
boost::circular_buffer< std::pair< IceUtil::Time, double > > dataHistory
Definition: RTFilterBase.h:59
armarx::rtfilters::RTFilterBase
The RTFilterBase class is the base class for all real time capable filters.
Definition: RTFilterBase.h:41
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:30