OBF-file - Revision history

Froehlich: /* Common parameters */ add note

2025-11-01T15:58:12Z

Common parameters: add note

← Older revision		Revision as of 08:58, 1 November 2025
Line 128:		Line 128:
	:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.		:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.
	:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>		:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
	<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.		:<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
	* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012\|}}		* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012\|}}
	:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.		:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
Line 149:		Line 149:
	::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series		::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series
	::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series		::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series
			:NOTE: The division into years begins at the start of the defined evaluation period (or simulation period if not defined)
	The following options are '''deprecated''' and only kept for backwards compatibility:		The following options are '''deprecated''' and only kept for backwards compatibility:
	* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency		* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency

Froehlich: /* Common parameters */ typo

2025-11-01T15:52:55Z

Common parameters: typo

← Older revision		Revision as of 08:52, 1 November 2025
Line 143:		Line 143:
	:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>		:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
	* <code>BIAS</code>: Absolute volume error [%]		* <code>BIAS</code>: Absolute volume error [%]
	* <code>~~AFPB~~</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019\|}}		* <code>APFB</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019\|}}
	:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.		:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.
	:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>		:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>

Froehlich: /* Common parameters */ AFPB (Annual Peak Flow Bias) added in BlueM.Opt v2.5.0

2025-11-01T15:52:17Z

Common parameters: AFPB (Annual Peak Flow Bias) added in BlueM.Opt v2.5.0

← Older revision		Revision as of 08:52, 1 November 2025
Line 143:		Line 143:
	:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>		:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
	* <code>BIAS</code>: Absolute volume error [%]		* <code>BIAS</code>: Absolute volume error [%]
			* <code>AFPB</code>: Annual Peak Flow Bias{{:Literatur:Mizukami_2019\|}}
			:<code>0 ≤ APFB ≤ ∞</code>. Smaller is better.
			:<math>\text{APFB} = \sqrt{ (\mu_{peakQ_s} / \mu_{peakQ_o} - 1)^2 }</math>
			:with
			::<code>μ<sub>peakQ<sub>s</sub></sub></code>: mean of the simulated annual peak flow series
			::<code>μ<sub>peakQ<sub>o</sub></sub></code>: mean of the observed annual peak flow series
	The following options are '''deprecated''' and only kept for backwards compatibility:		The following options are '''deprecated''' and only kept for backwards compatibility:
	* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency		* <code>NashSutt</code>: Modified Nash-Sutcliffe efficiency

Froehlich: /* Common parameters */ table formatting

2025-11-01T15:27:04Z

Common parameters: table formatting

Froehlich: /* Common parameters */

2023-10-05T07:43:41Z

Common parameters

← Older revision		Revision as of 00:43, 5 October 2023
Line 95:		Line 95:
	Direction of desired optimization:		Direction of desired optimization:
	*<code>-</code>: The objective function should be minimized (default)		*<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~~).		*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
	\|-		\|-
	\| '''Op'''erator or '''Fac'''tor<br/>(optional)		\| '''Op'''erator or '''Fac'''tor<br/>(optional)

Froehlich: /* Common parameters */ Fix KGE reference

2023-10-05T07:40:56Z

Common parameters: Fix KGE reference

← Older revision		Revision as of 00:40, 5 October 2023
Line 129:		Line 129:
	:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>		:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\right)^2}</math>
	<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.		<code>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
	* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:~~Gupta_2009~~\|}}		* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Kling_2012\|}}
	:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.		:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.
	:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>		:<math>\text{KGE} = 1 - \sqrt{ (r - 1)^2 + (\beta - 1)^2 + (\gamma - 1)^2 }</math>

Froehlich at 20:09, 22 September 2023

2023-09-22T20:09:48Z

← Older revision		Revision as of 13:09, 22 September 2023
Line 19:		Line 19:
	The file is divided into several blocks, each of which is optional. Each block is identified by its heading:		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.		* '''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~~).		* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (only for [[SWMM]] applications).
	* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.		* '''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		* '''Aggregate''': Aggregate objective functions

Froehlich: /* Common parameters */ add WBL file extension (v2.4.1)

2023-09-22T20:05:05Z

Common parameters: add WBL file extension (v2.4.1)

← Older revision		Revision as of 13:05, 22 September 2023
Line 104:		Line 104:
	*''number'': The objective function value is multiplied by the given number and then added to 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:		\| '''File''' \|\| The file extension of 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>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
	* <code>KWL</code> (only for [[BlueM.Sim]])		* <code>KWL</code> (only for [[BlueM.Sim]])
			* <code>WBL</code> (only for [[TALSIM]])
	* <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>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]])		* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])

Froehlich: /* "Series" */ fix link

2023-09-22T20:02:59Z

"Series": fix link

← Older revision		Revision as of 13:02, 22 September 2023
Line 164:		Line 164:
	\| '''RefName'''<br/>(optional) \|\| Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format\|WEL file]]).		\| '''RefName'''<br/>(optional) \|\| Specifies the name of the reference time series. Only necessary if the time series file specified under '''RefFile''' contains multiple series (e.g. [[WEL-format\|WEL file]]).
	\|-		\|-
	\| '''RefFile''' \|\| The filename of the file containing the reference time series<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>		\| '''RefFile''' \|\| The filename of the file containing the reference time series<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see [https://github.com/bluemodel/BlueM.Opt/issues/151 #151])</span>
	\|}		\|}

Froehlich: /* Common parameters */ Updated lnNSE formula for v2.2.0

2023-02-09T18:24:07Z

Common parameters: Updated lnNSE formula for v2.2.0

← Older revision		Revision as of 11:24, 9 February 2023
Line 126:		Line 126:
	* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970\|}}		* <code>lnNSE</code>: Logarithmic Nash-Sutcliffe efficiency{{:Literatur:Nash-Sutcliffe_1970\|}}
	:<code>-∞ ≤ lnNSE ≤ 1</code>. Larger is better.		:<code>-∞ ≤ lnNSE ≤ 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>		:<math>lnNSE=1-\frac{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-ln(Q_{sim}^t+\epsilon)\right)^2}{\sum_{t=1}^T\left(ln(Q_{obs}^t+\epsilon)-\overline{ln(Q_{obs}+\epsilon)}\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>ε</code> is set to 1% of the average value of <code>Q<sub>obs</sub></code> as recommended by {{:Literatur:Pushpalatha_2012}}.
	* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Gupta_2009\|}}		* <code>KGE</code>: Kling-Gupta efficiency{{:Literatur:Gupta_2009\|}}
	:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.		:<code>-∞ ≤ KGE ≤ 1</code>. Larger is better.

← Older revision		Revision as of 08:27, 1 November 2025
Line 83:		Line 83:
	:{\| cellpadding="5" cellspacing="0" border="0" class="standard stripes"		:{\| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
	\|-		\|-
	! width="150" \| Parameter !! ~~width="600" \|~~ Description		! width="150" \| Parameter !! 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.		\| valign="top" \| '''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		\| valign="top" \| '''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.		\| valign="top" \| '''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)		\| valign="top" \| '''D'''irection<br/>(optional)
	\|		\|
	Direction of desired optimization:		Direction of desired optimization:
Line 97:		Line 97:
	*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).		*<code>+</code>: The objective function should be maximized (this causes the objective function values to be multiplied by <code>-1</code> internally).
	\|-		\|-
	\| '''Op'''erator or '''Fac'''tor<br/>(optional)		\| valign="top" \| '''Op'''erator or '''Fac'''tor<br/>(optional)
	\|		\|
	Optional, only used for aggregated objective functions		Optional, only used for aggregated objective functions
Line 104:		Line 104:
	*''number'': The objective function value is multiplied by the given number and then added to the group		*''number'': The objective function value is multiplied by the given number and then added to the group
	\|-		\|-
	\| '''File''' \|\| The file extension of the simulation result file containing the simulation result from which the objective function should be calculated. Supported values:		\| valign="top" \| '''File''' \|\| The file extension of 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>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
	* <code>KWL</code> (only for [[BlueM.Sim]])		* <code>KWL</code> (only for [[BlueM.Sim]])
Line 111:		Line 111:
	* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])		* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
	\|-		\|-
	\| '''SimResult''' \|\| The identifier of the simulation result from which the objective function should be calculated.		\| valign="top" \| '''SimResult''' \|\| The identifier of the simulation result from which the objective function should be calculated.
	\|-		\|-
	\| '''ObjFunc''' \|\| Specifies which objective function to use.		\| valign="top" \| '''ObjFunc''' \|\| Specifies which objective function to use.
	Supported values for comparing values:		Supported values for comparing values:
	* <code>SE</code>: Squared error		* <code>SE</code>: Squared error
Line 151:		Line 151:
	:<math>lnNSE_{mod}=1-lnNSE</math>		:<math>lnNSE_{mod}=1-lnNSE</math>
	\|-		\|-
	\| '''CurValue'''<br/>(optional) \|\| An optional value that is displayed in diagrams to serve as an indication of improvement.		\| valign="top" \| '''CurValue'''<br/>(optional) \|\| An optional value that is displayed in diagrams to serve as an indication of improvement.
	\|}		\|}