as_transfr: Create transfR object

In transfR: Transfer of Hydrograph from Gauged to Ungauged Catchments

Create transfR object

Description

Create a transfR object or add new attributes to a transfR object.

Usage

as_transfr(
  object,
  st,
  uc,
  lagtime,
  surface,
  delineation,
  outlet,
  centroid,
  uh,
  hl
)

Arguments

object	object of class transfR
st	spatio-temporal array of class stars. Observed discharge must be identified by the column name 'Qobs'. Time should be the first dimension, space the second dimension. If no unit is provided, Qobs is assumed to be in [m^3/s] and RnInv is assumed to be in [mm/h] (or [mm/d] at daily time step).
uc	vector of the streamflow velocities of the catchments. If no unit is provided, uc is assumed to be in [m/s].
lagtime	vector of the lag times of the catchments. If no unit is provided, lagtime is assumed to be in [h].
surface	vector of the surfaces of the catchments. If no unit is provided, surface is assumed to be in [km^2].
delineation	spatial layer of the boundary of the catchments of class sfc_POLYGON.
outlet	spatial layer of the outlets of the catchments of class sfc_POINT.
centroid	spatial layer of the centroids of the catchments of class sfc_POINT.
uh	list of the unit hydrographs of the catchments.
hl	list of hydraulic length objects, one per catchment. Each element must be a stars object, a numeric matrix or a numeric vector. For a single catchment, one object can be supplied directly. If no unit is provided, hl is assumed to be in [m]. See details below.

Details

This function creates an object of class transfR or adds new attributes to an existing transfR object. It can be used to gather and organise most of the inputs and outputs of the other functions, like streamflow velocities, unit hydrographs, a priori estimates of net rainfall, inversions and simulations for every catchment.

This function can be used to organise the two user inputs required for a conventional use of the package, namely st and hl. The hydraulic lengths are defined as the flow path length from each pixel to the outlet within the river network \insertCiteCudennec2004,Aouissi2013transfR. Catchment delineations and hydraulic lengths need to be prepared beforehand by the user. This package does not provide functions to create them. However, several GIS software packages can extract them from a digital elevation model, such as GRASS toolkits \insertCiteJasiewicz2011transfR, Whitebox GAT (\insertCite@see @Lindsay2016;textualtransfR or WhiteboxTools), TauDEM (D. Tarboton, Utah State University) or online services (\insertCite@see @Squividant2015;textualtransfR for catchment delineation in the Brittany French region).

Value

An object of class transfR.

References

\insertRef

Aouissi2013transfR

\insertRef

Cudennec2004transfR

\insertRef

Jasiewicz2011transfR

\insertRef

Lindsay2016transfR

\insertRef

Squividant2015transfR

Examples

data(Oudon)
object <- as_transfr(st = Oudon$obs, hl = Oudon$hl)

transfR documentation built on July 24, 2026, 5:06 p.m.