BaseflowFilter {baseflow}R Documentation

Constructor function of class BaseflowFilter

Description

Standard construction function of BaseflowFilter objects, used by package baseflow to store filtering information for a given catchment. The object is created with NA values of baseflow and level of filtering reservoir, it is then necessary to run perform_filtering function to compute them.

Usage

BaseflowFilter(BasinData, alpha, updateFunction = "quadr")

Arguments

BasinData

A BasinData object containing hydroclimatic data for the catchment under study.

alpha

Numeric parameter of the filtering reservoir. Its dimension depends on the used update function.

updateFunction

Character string giving reservoir function : must be one of "quadr", "lin" or "exp". Defalut is "quadr".

Value

A BaseflowFilter object containing provided data. Baseflow numeric field R and reservoir level V are filled with NA, it is thus necessary to call perform_filtering function to compute R and V.

Author(s)

Pelletier and Andreassian (antoine.pelletier@irstea.fr)

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

BasinData

BaseflowFilter

BasinData

perform_filtering

Examples

library(baseflow)

# Loading example data from airGR package
data(L0123001, package = 'airGR')

# Defining BasinData object

Name <- BasinInfo$BasinName
startDate <- BasinObs$DatesR[1]
endDate <- BasinObs$DatesR[length(BasinObs$DatesR)]
P <- BasinObs$P
PET <- BasinObs$E
Qobs <- BasinObs$Qmm

BasinData_Example <- BasinData(Name, startDate, endDate, P, PET, Qobs, fill = "GR4J")

# Creating BaseflowFilter object
BaseflowFilter_Example <- BaseflowFilter(BasinData_Example, 1000, updateFunction = 'quadr')

# Computing baseflow
BaseflowFilter_Example <- perform_filtering(BaseflowFilter_Example)

# Plotting computed separation
plot(BaseflowFilter_Example)

[Package baseflow version 0.13.2 Index]