mo_errormeasures::nse Interface Reference

Nash Sutcliffe Efficiency. More...

Public Member Functions
real(sp) function	nse_sp_1d (x, y, mask)
real(dp) function	nse_dp_1d (x, y, mask)
real(dp) function	nse_dp_2d (x, y, mask)
real(sp) function	nse_sp_2d (x, y, mask)
real(sp) function	nse_sp_3d (x, y, mask)
real(dp) function	nse_dp_3d (x, y, mask)

Detailed Description

Nash Sutcliffe Efficiency.

Calculates the Nash Sutcliffe Efficiency

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

where \( x\) is the observation and \( y\) is the modelled data.

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   = nse(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

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) :: NSE

NSE.

Note

Input values must be floating points.

Authors

Matthias Zink

Date

Sept 2012

Definition at line 354 of file mo_errormeasures.f90.

Member Function/Subroutine Documentation

nse_dp_1d()

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

Definition at line 2256 of file mo_errormeasures.f90.

nse_dp_2d()

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

Definition at line 2338 of file mo_errormeasures.f90.

nse_dp_3d()

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

Definition at line 2419 of file mo_errormeasures.f90.

nse_sp_1d()

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

Definition at line 2214 of file mo_errormeasures.f90.

nse_sp_2d()

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

Definition at line 2298 of file mo_errormeasures.f90.

nse_sp_3d()

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

Definition at line 2378 of file mo_errormeasures.f90.

---

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

• src/mo_errormeasures.f90