====== Running mean ======

The running mean will integrate a given input over time and return the mean value. In versions prior to Ecolego 6, this functionality was incorporated in the recorder block.

When creating a running mean block, you must specify either the name of the object to integrate, or an expression to integrate. This is called the “Target expression”.

The running mean block makes heavy use of [[Discrete_Event|discrete events]]. By selecting [[Discrete_Event|discrete events]] you can tell the block when to start or stop the integration or when you want to reset the integration.

===== Creating a running mean block =====

From the [[Projects_window|Projects window]]

  * Expand the Project to which you wish to add the running mean by clicking the + symbol next to it. Right-click on ‘Blocks’, or a [[Sub-system|sub-system]] in ‘Blocks’, and select **Running mean** from the pop-up menu.

From the [[Matrix_window|Matrix window]]

  * Right click an empty diagonal cell of the matrix and select **Running mean** from the the pop-up menu.

From the [[Blocks_window|Blocks window]]

  * Place the mouse anywhere over the area of this window and right-click on it. Select **New | Running mean** from the pop-up menu, //or//
  * In the title bar, select **Running mean** from the **Type** drop-down list and click on the {{:New24.png|New}} button.

===== Editing a running mean block =====

|Note|Most block properties can be edited directly in the [[Blocks_window|Blocks window]].|

The block editor is shown by right-clicking the block in a window and selecting **Edit**. In the [[Blocks_window|Blocks window]], you can also show the block editor by selecting the block and clicking the {{:Edit24.png|Edit}} button, or by double-clicking the right-most “validation” column of the block.

The block editor has three tabs:

==== Properties ====

This page lets you edit basic properties such as name, sub-system and base unit. See [[Editing_properties|editing properties]] for more information.

==== Appearance ====

This page lets you edit the visual properties of the block in the [[Matrix_window|matrix window]] and [[Graph_window|graph window]]. See [[Editing_appearance|editing appearance]] for more information.

==== Values ====

**Dimension** - You can specify the dimension of the block by using the **Type** drop down list. Depending on the dimension the index drop down lists are activated.

**Data** - The data table let you specify index specific properties like target expression and start/stop recording events.

  * **//Indices//** - For blocks that are non-scalar, the first columns will specify indices from the [[Index_list|index lists]]. This allows you to specify different expressions for different indices.
  * **Target expression** - Enter either just the ID of an object to integrate, or enter a full expression.
  * **Start recording** - Select a [[Discrete_Event|discrete event]] or [[Time_Event|time event]] which will indicate when the integration should start.
  * **Stop recording** - Select a [[Discrete_Event|discrete event]] or [[Time_Event|time event]] which will indicate when the integration should stop. The last value calculated will be saved.
  * **Reset** - Select a [[Discrete_Event|discrete event]] or [[Time_Event|time event]] which will trigger a reset. The value of the running mean will then be reset to the current value of target expression, and will start a new running mean calculation, starting from the input reset point.
  * **Information** - By using the [[Table_control_button|Table control button]] you can display more columns that will help you document your model.
//
*Note that if the user has put both Reset and Stop to the Running mean, Stop will have the priority. \\
*If Star/Stop/Reset are left empty, running mean will calculate from the Time point 0 until the end of the Simulation.//

===== Example: Running mean =====

Consider a model for contamination of air, where we want to consider the average dose received by a person visiting the area between may and august.

Let us assume that the current concentration in air is given by an expression //C_air//, the time (may) when the person enters the area is given by parameter //t_enter// and that the time (august) when the person leaves the area is given by parameter //t_leave//.

First create a [[Discrete_Event|discrete event]] named //Event_enter// which will start the integration at t = t_enter. The values given to this block are:

^Property        ^Value  ^
|Left expression |time   |
|Direction       |->     |
|Right expression|t_enter|

Create another [[Discrete_Event|discrete event]] //Event_leave// which will stop the integration at t = t_leave, where the values are the same as for the first event but where //t_leave// is used instead of //t_enter//.

Create a running mean block and give it the following values:

^Property         ^Value      ^
|Target expression|C_air      |
|Start recording  |Event_enter|
|Stop recording   |Event_leave|

===== See also =====

  * [[Block|Blocks]]
  * The [[Blocks_window|Blocks window]]
  * The [[Matrix_window|Matrix window]]
  * The [[Graph_window|Graph window]]