0.6.2-dev0
FORCES
FORtran lib for Comp. Env. Sys.
Loading...
Searching...
No Matches
mo_errormeasures::lnnse Interface Reference

Logarithmic Nash Sutcliffe Efficiency. More...

Public Member Functions

real(sp) function lnnse_sp_1d (x, y, mask)
 
real(dp) function lnnse_dp_1d (x, y, mask)
 
real(dp) function lnnse_dp_2d (x, y, mask)
 
real(sp) function lnnse_sp_2d (x, y, mask)
 
real(sp) function lnnse_sp_3d (x, y, mask)
 
real(dp) function lnnse_dp_3d (x, y, mask)
 

Detailed Description

Logarithmic Nash Sutcliffe Efficiency.

Calculates the Logarithmic Nash Sutcliffe Efficiency

\[LNNSE = \frac{\sum_i(\ln(y_i) - \ln(x_i))^2} {\sum_i (\ln(x_i) - \ln(\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. Note that the mask is intent inout, since values which are less or equal zero will be masked additionally. \( 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 = lnnse(vec1, vec2, mask=(vec >= 0.))
--> m = 1.0

See also example in test directory.

Parameters
[in]real(sp/dp), dimension() :: x, y1D/2D/3D-array with input numbers.
[in]logical, optional :: mask1D/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) :: LNNSELNNSE.
Note
Input values must be floating points.
Author
Juliane Mai
Date
May 2013
Author
Rohini Kumar
Date
May 2013
  • mean of logQ

Definition at line 229 of file mo_errormeasures.f90.

Member Function/Subroutine Documentation

◆ lnnse_dp_1d()

real(dp) function mo_errormeasures::lnnse::lnnse_dp_1d ( real(dp), dimension(:), intent(in)  x,
real(dp), dimension(:), intent(in)  y,
logical, dimension(:), intent(inout), optional  mask 
)

Definition at line 1525 of file mo_errormeasures.f90.

◆ lnnse_dp_2d()

real(dp) function mo_errormeasures::lnnse::lnnse_dp_2d ( real(dp), dimension(:, :), intent(in)  x,
real(dp), dimension(:, :), intent(in)  y,
logical, dimension(:, :), intent(inout), optional  mask 
)

Definition at line 1639 of file mo_errormeasures.f90.

◆ lnnse_dp_3d()

real(dp) function mo_errormeasures::lnnse::lnnse_dp_3d ( real(dp), dimension(:, :, :), intent(in)  x,
real(dp), dimension(:, :, :), intent(in)  y,
logical, dimension(:, :, :), intent(inout), optional  mask 
)

Definition at line 1753 of file mo_errormeasures.f90.

◆ lnnse_sp_1d()

real(sp) function mo_errormeasures::lnnse::lnnse_sp_1d ( real(sp), dimension(:), intent(in)  x,
real(sp), dimension(:), intent(in)  y,
logical, dimension(:), intent(inout), optional  mask 
)

Definition at line 1468 of file mo_errormeasures.f90.

◆ lnnse_sp_2d()

real(sp) function mo_errormeasures::lnnse::lnnse_sp_2d ( real(sp), dimension(:, :), intent(in)  x,
real(sp), dimension(:, :), intent(in)  y,
logical, dimension(:, :), intent(inout), optional  mask 
)

Definition at line 1582 of file mo_errormeasures.f90.

◆ lnnse_sp_3d()

real(sp) function mo_errormeasures::lnnse::lnnse_sp_3d ( real(sp), dimension(:, :, :), intent(in)  x,
real(sp), dimension(:, :, :), intent(in)  y,
logical, dimension(:, :, :), intent(inout), optional  mask 
)

Definition at line 1696 of file mo_errormeasures.f90.


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