BaseflowFilter-class: Class 'BaseflowFilter'

In baseflow: Computes Hydrograph Separation

Description

Class used by package baseflow to store results of a baseflow filtering for a given catchment.

Objects from the Class

Objects can be created by calls of the form new("BaseflowFilter", ...), but it is recommended to use BaseflowFilter function to create this object.

Slots

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.

Methods

as.data.frame

signature(x = "BaseflowFilter"): transforms object into dataframe.

plot

signature(x = "BaseflowFilter"): plots baseflow separation on the hydrograph.

print

signature(x = "BaseflowFilter"): prints object to console.

show

signature(object = "BaseflowFilter"): shows object in console.

summary

signature(object = "BaseflowFilter"): shows a summary of the object.

Author(s)

Pelletier and Andreassian ([e-mail])

References

Pelletier, A. and Andréassian, V.: Hydrograph separation: an impartial parametrisation for an imperfect method, Hydrol. Earth Syst. Sci., 24, 1171–1187, doi: 10.5194/hess-24-1171-2020, 2020

See Also

BaseflowFilter

perform_filtering

BasinData

Examples

showClass("BaseflowFilter")

baseflow documentation built on March 19, 2021, 1:06 a.m.