teehr.metric_funcs#

Contains UDFs for metric calculations for use in Spark queries.

Functions

annual_peak_relative_bias

Annual peak relative bias.

average

Average.

count

Count.

kling_gupta_efficiency

Kling-Gupta Efficiency (2009).

kling_gupta_efficiency_mod1

Kling-Gupta Efficiency - modified 1 (2012).

kling_gupta_efficiency_mod2

Kling-Gupta Efficiency - modified 2 (2021).

max_value_delta

Max value delta.

max_value_time

Max value time.

max_value_timedelta

Max value time delta.

maximum

Maximum.

mean_absolute_error

Mean absolute error.

mean_absolute_relative_error

Absolute Relative Error.

mean_error

Mean Error.

mean_squared_error

Mean squared error.

minimum

Minimum.

multiplicative_bias

Multiplicative Bias.

nash_sutcliffe_efficiency

Nash-Sutcliffe Efficiency.

nash_sutcliffe_efficiency_normalized

Normalized Nash-Sutcliffe Efficiency.

pearson_correlation

Pearson Correlation Coefficient.

r_squared

R-squared.

relative_bias

Relative Bias.

root_mean_squared_error

Root mean squared error.

root_mean_standard_deviation_ratio

Root mean standard deviation ratio.

spearman_correlation

Spearman Rank Correlation Coefficient.

sum

Sum.

variance

Variance.