View source for OBF-file

{{Template:BlueM.Opt input files}}
<div class="info_versionen">
'''Versions:'''
* '''current''' v1.9
* [{{SERVER}}/index.php?title=OBF-file&oldid=7469 v1.8] (up to r1843)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7401 v1.7] (as of r1785)
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
This file defines the objective functions for the optimization. 

The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.OBF</code>''', and be located in the same directory as the rest of the dataset. (In version prior to v1.8, this file had the file extension <code>.ZIE</code>.)

<br clear="all"/>

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (currently only functional for [[SWMM]] applications, see #414).
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''Aggregate''': Aggregate objective functions

==File format==
<bluem>
*Objective functions
*===================
*
*Series
*------
*
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name             | Group   | D | OpFac | File  | SimResult  | ObjFunc |           Evaluation period         |       Reference series      | CurValue |
*|     |                  |         |   |       |       |            |         |       Start      |     End          | RefName   | RefFile         |          |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
 |  P  | Kling-Gupta      |         | + |       |  WEL  | B401_1AB   | KGE     | 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre  |          |
 |  S  | NashSutcliffe    |         | + |       |  WEL  | B401_1AB   | NSE     | 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre  |          |
 |  S  | VolumeError      |         | - |       |  WEL  | B401_1AB   | BIAS    | 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre  |          |
 |  S  | MeanSquaredError |         | - |       |  WEL  | B401_1AB   | MSE     | 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre  |          |
*|-----|------------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name          | Group   | D | OpFac | File  | SimResult | ObjFunc | TargetElement | TargetValue |          | CurValue |
*|     |               |         |   |       |       |           |         | (Block)       | (Column)    | RefValue |          |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
 |  S  | OutfallLoad   |         | - |       |  RPT  |           | AE      | OutfallNode   | AvgFlow     |     0    |          |
 |  S  | Storage401    | Storage | - |   +   |  BLZ  | B401      |         | Speicher      | maxVolume   |          |          |
 |  S  | Storage701    | Storage | - |   +   |  BLZ  | B701      |         | Speicher      | maxVolume   |          |          |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name          | Group   | D | OpFac | File  | SimResult  | ObjFunc | Evaluation period | Reference value      | CurValue |
*|     |               |         |   |       |       |            |         | Start   | Ende    | ValueType | RefValue |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
 |  S  | OutfallLoad   |         | - |       |  WEL  | B401_1AB   | AE      |         |         |           |          |          |
 |  P  | PeakError     |         | - |       |  WEL  | S3  _1ZU   | SE      |         |         | Max       | 29.33    |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name         | Group   | D | CurValue |
*|-----|--------------|---------|---|----------|
 |  P  | TotalStorage | Storage |   |          |
*|-----|--------------|---------|---|----------|
</bluem>

The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.

==Description==
===Common parameters===
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|- 
! width="150" | Parameter !! width="600" | Description
|-
| '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
|-
| '''Name''' || Arbitrary name of the objective function
|-
| '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
|-
| '''D'''irection<br/>(optional)
|
Direction of desired optimization:
*<code>-</code>: The objective function should be minimized (default)
*<code>+</code>: The objective function should be maximized. This causes the objective function values to be multiplied by <code>-1</code> (#303).
|-
| '''Op'''erator or '''Fac'''tor<br/>(optional)
|
Optional, only used for aggregated objective functions
*<code>+</code>: The objective function value is added to the group
*<code>-</code>: The objective function value is subtracted from the group
*''number'': The objective function value is multiplied by the given number and then added to the group
|-
| '''File''' || The simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
* <code>KWL</code> (only for [[BlueM.Sim]])
* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
|-
| '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
|-
| '''ObjFunc''' || Specifies which objective function to use. 
Supported values for comparing values:
* <code>SE</code>: Squared error
* <code>AE</code>: Absolute error
Supported values for comparing series:
* <code>MAE</code>: Mean abolute error
* <code>SAE</code>: Sum of absolute errors
* <code>MSE</code>: Mean squared error
* <code>SSE</code>: Sum of squared errors
* <code>NSE</code>: Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-&infin; &le; NSE &le; 1</code>. Larger is better.
:<math>NSE=1-\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970|}}
:<code>-&infin; &le; lnNSE &le; 1</code>. Larger is better.
:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t)-ln(Q_{sim}^t)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t)-ln(\overline{Q_{obs}})\right)^2}</math>
:NOTE: In order to avoid problems with <code>ln(0)</code>, all observed and simulated timeseries values are set to a minimum of 1% of the average value of <code>Q<sub>obs</sub></code>.
* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Gupta_2009|}}
:<code>-&infin; &le; KGE &le; 1</code>. Larger is better.
:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>
:with
::<code>r</code>: correlation coefficient
::<code>&beta;</code>: bias ratio
::<code>&gamma;</code>: variability ratio
* <code>NGT</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>SGT</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>NLT</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>SLT</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>DET</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 &le; R² &le; 1</code>:
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>BIAS</code>: Absolute volume error [%]
The following options are '''deprecated''' and only kept for backwards compatibility:
* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency
:modified formula with <code>0 &le; NSE<sub>mod</sub> &le; &infin;</code>. Smaller is better. 
:<math>NSE_{mod}=1-NSE</math>
* <code>LnNashSutt</code>: Modified logarithmic Nash-Sutcliffe efficiency
:modified formula with <code>0 &le; lnNSE<sub>mod</sub> &le; &infin;</code>. Smaller is better. 
:<math>lnNSE_{mod}=1-lnNSE</math>
|-
| '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
|}

==="Series"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|- 
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''RefName'''<br/>(nur bei Referenzreihen und .WEL als Referenzdatei) || Specifies the identifier of the time series with which the simulation result should be compared. Only necessary if the time series file specified under '''RefFile''' is in [[WEL-format]]. 
|-
| '''RefFile''' || The filename of the reference time series ([[ZRE-Format|.zre]] or [[WEL-Format|.wel]])<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see #218)</span>
|}


==="Values"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|- 
! width="150" | Parameter !! width="500" | Description
|-
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
|-
| '''TargetValue (Column)''' || Specifies the target variable within the block.
|-
| '''RefValue''' || The reference value with which the simulation result should be compared.
|}

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|- 
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
|-
| '''SWMM''' || NodeFlooding || HoursFlooded
|-
| '''SWMM''' || NodeFlooding || FloodVolume
|-
| '''SWMM''' || StorageVolume || AvgVolume
|-
| '''SWMM''' || StorageVolume || AvgPctFull
|-
| '''SWMM''' || StorageVolume || MaxVolume
|-
| '''SWMM''' || StorageVolume || MaxPctFull
|-
| '''SWMM''' || StorageVolume || MaxOutflow
|-
| '''SWMM''' || OutfallLoad || MaxFlow
|-
| '''SWMM''' || OutfallLoad || FlowVolume
|-
| '''SWMM''' || OutfallLoad || Pollutant_[no]
|-
| '''SWMM''' || Pumping || OnlineTime
|-
| '''SWMM''' || Pumping || TotalEnergy
|-
| '''Smusi''' || EntlVolumen || SumVol
|-
| '''Smusi''' || MaxAbfluss || Qmax
|-
| '''Smusi''' || EntlFracht || CSBspez
|}

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

==="ValueFromSeries"===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|- 
! width="150" | Parameter !! width="500" | Description
|-
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
Format: <code>dd.mm.yyyy hh:mm</code><br/>
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
|-
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
* <code>Max</code>: Maximum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
|}

==Literature==
<references/>

[[Category:BlueM.Opt input files|O]]