mo_errormeasures::rmse Interface Reference

RMS Error. More...

Public Member Functions
real(sp) function	rmse_sp_1d (x, y, mask)
real(dp) function	rmse_dp_1d (x, y, mask)
real(sp) function	rmse_sp_2d (x, y, mask)
real(dp) function	rmse_dp_2d (x, y, mask)
real(sp) function	rmse_sp_3d (x, y, mask)
real(dp) function	rmse_dp_3d (x, y, mask)

Detailed Description

RMS Error.

Calculates the root-mean-square error

\[ RMSE = \sqrt{\frac{\sum_i{(y_i - x_i)^2}} {{N_\text{count}}}} \]

If an optional 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   = rmse(vec1, vec2, mask=(vec >= 0.))
--> m = 0.0

See also example in test directory.

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

RMSE.

Note

Input values must be floating points.

Authors

Matthias Zink

Date

Sept 2012

Definition at line 472 of file mo_errormeasures.f90.

Member Function/Subroutine Documentation

rmse_dp_1d()

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

Definition at line 2927 of file mo_errormeasures.f90.

rmse_dp_2d()

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

Definition at line 2993 of file mo_errormeasures.f90.

rmse_dp_3d()

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

Definition at line 3060 of file mo_errormeasures.f90.

rmse_sp_1d()

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

Definition at line 2894 of file mo_errormeasures.f90.

rmse_sp_2d()

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

Definition at line 2960 of file mo_errormeasures.f90.

rmse_sp_3d()

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

Definition at line 3026 of file mo_errormeasures.f90.

---

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

• src/mo_errormeasures.f90