mo_errormeasures::wnse Interface Reference

weighted Nash Sutcliffe Efficiency. More...

Public Member Functions
real(sp) function	wnse_sp_1d (x, y, mask)
real(dp) function	wnse_dp_1d (x, y, mask)
real(dp) function	wnse_dp_2d (x, y, mask)
real(sp) function	wnse_sp_2d (x, y, mask)
real(sp) function	wnse_sp_3d (x, y, mask)
real(dp) function	wnse_dp_3d (x, y, mask)

Detailed Description

weighted Nash Sutcliffe Efficiency.

Calculates the weighted Nash Sutcliffe Efficiency

\[ wNSE = \frac{\sum_i {x_i (y_i - x_i)^2}} {\sum_i{ x_i (x_i - \bar x)^2}} \]

where \( x\) is the observation and \( y\) is the modelled data. This objective function is introduced in Hundecha and Bardossy, 2004.

If an optinal mask is given, the calculations are over those locations that correspond to true values in the mask. \( x\) and \( y\) can be single or double precision. The result will have the same numerical precision.

Example

vec1 = (/ 1., 2, 3., -999., 5., 6. /)
vec2 = (/ 1., 2, 3., -999., 5., 6. /)
m   = wnse(vec1, vec2, mask=(vec >= 0.))
--> m = 1.0

See also example in test directory.

Literature

1. Nash, J., & Sutcliffe, J. (1970). River flow forecasting through conceptual models part I: A discussion of principles. Journal of Hydrology, 10(3), 282-290. doi:10.1016/0022-1694(70)90255-6
   
2. Hundecha and Bardossy (2004). Modeling of the effect of land use changes on the runoff generation of a river domain through parameter regionalization of a watershed model. Journal of Hydrology, 292, 281-295

Parameters

[in]	real(sp/dp), dimension() :: x, y	1D/2D/3D-array with input numbers.
[in]	logical, optional :: mask	1D/2D/Array-array of logical values with size(x/y). If present, only those locations in vec corresponding to the true values in mask are used.

Return values

real(sp/dp) :: wNSE

wNSE.

Note

Input values must be floating points.

Authors

Matthias Zink & Bjoern Guse

Date

May 2018

Definition at line 521 of file mo_errormeasures.f90.

Member Function/Subroutine Documentation

wnse_dp_1d()

real(dp) function mo_errormeasures::wnse::wnse_dp_1d	(	real(dp), dimension(:), intent(in)	x,
		real(dp), dimension(:), intent(in)	y,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 3139 of file mo_errormeasures.f90.

wnse_dp_2d()

real(dp) function mo_errormeasures::wnse::wnse_dp_2d	(	real(dp), dimension(:,:), intent(in)	x,
		real(dp), dimension(:,:), intent(in)	y,
		logical, dimension(:,:), intent(in), optional	mask
	)

Definition at line 3222 of file mo_errormeasures.f90.

wnse_dp_3d()

real(dp) function mo_errormeasures::wnse::wnse_dp_3d	(	real(dp), dimension(:,:,:), intent(in)	x,
		real(dp), dimension(:,:,:), intent(in)	y,
		logical, dimension(:,:,:), intent(in), optional	mask
	)

Definition at line 3303 of file mo_errormeasures.f90.

wnse_sp_1d()

real(sp) function mo_errormeasures::wnse::wnse_sp_1d	(	real(sp), dimension(:), intent(in)	x,
		real(sp), dimension(:), intent(in)	y,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 3096 of file mo_errormeasures.f90.

wnse_sp_2d()

real(sp) function mo_errormeasures::wnse::wnse_sp_2d	(	real(sp), dimension(:,:), intent(in)	x,
		real(sp), dimension(:,:), intent(in)	y,
		logical, dimension(:,:), intent(in), optional	mask
	)

Definition at line 3182 of file mo_errormeasures.f90.

wnse_sp_3d()

real(sp) function mo_errormeasures::wnse::wnse_sp_3d	(	real(sp), dimension(:,:,:), intent(in)	x,
		real(sp), dimension(:,:,:), intent(in)	y,
		logical, dimension(:,:,:), intent(in), optional	mask
	)

Definition at line 3262 of file mo_errormeasures.f90.

---

The documentation for this interface was generated from the following file:

• src/mo_errormeasures.f90