Average
Module used to calculate the average of its input over time. There are three different types of average that can be calculated: Cumulative moving average (CMA) which is the default; Simple moving average (SMA) over a window set by window_size; and exponentially moving average (EMA) with a weight set by alpha.
Example XML definition
A simple example
<module
class = "Average"
name = "Average"
/>
Parameters
| Name | Description | Type | Default |
|---|---|---|---|
| class | The class name for the module; must be "Average". | string | |
| name | The name of this instance of the module. | string | |
| type | the type of average | choices: SMA CMA EMA | SMA |
| window_size | the window size for SMA | int | 100 |
| alpha | the weight for the new value for EMA | float | 0.1 |
| termination_criterion | if the absolute average set by select is below this value the module will terminate execution of Ikaros | float | 0 |
| select | which value to use for the termination criteria | int | 0 |
Module Connections
Inputs
| Name | Description |
|---|---|
| INPUT | The input |
Outputs
| Name | Description |
|---|---|
| OUTPUT | The output |
Limitations
If run for very long numerical problems are likely to occur when the number of ticks or the sum of all inputs becomes too large.
Author
Christian Balkenius
christian.balkenius@lucs.lu.se
Lund University Cognitive Science
Files
Average.h
Average.cc
Average.ikc