Pyrogenesis  trunk
frequency_filter.h
Go to the documentation of this file.
1 /* Copyright (c) 2010 Wildfire Games
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining
4  * a copy of this software and associated documentation files (the
5  * "Software"), to deal in the Software without restriction, including
6  * without limitation the rights to use, copy, modify, merge, publish,
7  * distribute, sublicense, and/or sell copies of the Software, and to
8  * permit persons to whom the Software is furnished to do so, subject to
9  * the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef INCLUDED_FREQUENCY_FILTER
24 #define INCLUDED_FREQUENCY_FILTER
25 
26 // calculate frequency of events (tuned for 100 Hz)
28 {
29  virtual ~IFrequencyFilter() {}
30 
31  virtual void Update(double value) = 0;
32 
33  // smoothed but rapidly tracked frequency
34  virtual double SmoothedFrequency() const = 0;
35 
36  // stable, non-fluctuating value for user display
37  virtual int StableFrequency() const = 0;
38 };
39 
40 typedef shared_ptr<IFrequencyFilter> PIFrequencyFilter;
41 
42 // expectedFrequency is a guess that hopefully speeds up convergence
43 LIB_API PIFrequencyFilter CreateFrequencyFilter(double resolution, double expectedFrequency);
44 
45 #endif // #ifndef INCLUDED_FREQUENCY_FILTER
virtual int StableFrequency() const =0
Definition: frequency_filter.h:27
LIB_API PIFrequencyFilter CreateFrequencyFilter(double resolution, double expectedFrequency)
Definition: frequency_filter.cpp:250
shared_ptr< IFrequencyFilter > PIFrequencyFilter
Definition: frequency_filter.h:40
virtual void Update(double value)=0
virtual ~IFrequencyFilter()
Definition: frequency_filter.h:29
static double resolution
Definition: whrt.cpp:99
virtual double SmoothedFrequency() const =0