Commit 0ee81fd8 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

rely on centralised doc for flow transformation

No related merge requests found
Pipeline #40631 passed with stages
in 3 minutes and 30 seconds
Showing with 2 additions and 16 deletions
+2 -16
...@@ -44,23 +44,9 @@ namespace evalhyd ...@@ -44,23 +44,9 @@ namespace evalhyd
/// ///
/// transform: ``std::string``, optional /// transform: ``std::string``, optional
/// The transformation to apply to both streamflow observations and /// The transformation to apply to both streamflow observations and
/// predictions prior to the calculation of the *metrics*. The options /// predictions prior to the calculation of the *metrics*.
/// are listed in the table below.
/// ///
/// ========================= ================================== /// .. seealso:: :doc:`../../functionalities/transformation`
/// transformations details
/// ========================= ==================================
/// ``"sqrt"`` The square root function
/// **f(Q) = √Q** is applied.
/// ``"pow"`` The power function
/// **f(Q) = Qⁿ** is applied (where
/// the power **n** can be set through
/// the *exponent* parameter).
/// ``"inv"`` The reciprocal function
/// **f(Q) = 1/Q** is applied.
/// ``"log"`` The natural logarithm function
/// **f(Q) = ln(Q)** is applied.
/// ========================= ==================================
/// ///
/// exponent: ``double``, optional /// exponent: ``double``, optional
/// The value of the exponent n to use when the *transform* is the /// The value of the exponent n to use when the *transform* is the
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment