BaseflowFilter-class {baseflow} | R Documentation |
BaseflowFilter
Class used by package baseflow to store results of a baseflow filtering for a given catchment.
Objects can be created by calls of the form new("BaseflowFilter", ...)
, but it is recommended to use BaseflowFilter
function to create this object.
BasinData
:Object of class "BasinData"
giving hydroclimatic data of catchment (see BasinData-class).
R
:Vector of class "numeric"
giving filtered baseflow.
V
:Vector of class "numeric"
giving storage of the conceptual reservoir.
update
:Vector of class "logical"
, TRUE
at timesteps in which reservoir's level is updated, FALSE
otherwise.
updateFunction
:Object of class "character"
equal to "quadr"
, "lin"
or "exp"
, giving the nature of the conceptual reservoir.
alpha
:Object of class "numeric"
: value of "alpha"
reservoir parameter.
signature(x = "BaseflowFilter")
: transforms object into dataframe.
signature(x = "BaseflowFilter")
: plots baseflow separation on the hydrograph.
signature(x = "BaseflowFilter")
: prints object to console.
signature(object = "BaseflowFilter")
: shows object in console.
signature(object = "BaseflowFilter")
: shows a summary of the object.
Pelletier and Andreassian (antoine.pelletier@irstea.fr)
showClass("BaseflowFilter")