Calibration.GRiwrmInputsModel {airGRiwrm} | R Documentation |
Calibration of the parameters of one catchment or a network of sub-catchments
Description
Calibration algorithm that optimizes the error criterion selected as objective function using the provided functions.
Usage
## S3 method for class 'GRiwrmInputsModel'
Calibration(
InputsModel,
RunOptions,
InputsCrit,
CalibOptions,
useUpstreamQsim = TRUE,
...
)
## S3 method for class 'InputsModel'
Calibration(InputsModel, ...)
Calibration(InputsModel, ...)
Arguments
InputsModel |
[object of class InputsModel or GRiwrmInputsModel] see CreateInputsModel |
RunOptions |
[object of class RunOptions or GRiwrmRunOptions] see CreateRunOptions |
InputsCrit |
[object of class InputsCrit or GRiwrmInputsCrit] see CreateInputsCrit |
CalibOptions |
[object of class CalibOptions or GRiwrmCalibOptions] see CreateCalibOptions for details |
useUpstreamQsim |
boolean describing if simulated ( |
... |
further arguments passed to airGR::Calibration, see details |
Details
This function can be used either for a catchment (with an InputsModel object) or for a network (with a GRiwrmInputsModel object)
Argument classes should be consistent to the usage:
a
InputsModel
argument of class InputsModel must be followed by aRunOptions
argument of class RunOptions, aInputsCrit
argument of class InputsCrit and aCalibOptions
of class CalibOptions-
a
InputsModel
argument of class GRiwrmInputsModel must be followed by aRunOptions
argument of class GRiwrmRunOptions, aInputsCrit
argument of class GRiwrmInputsCrit and aCalibOptions
of class GRiwrmCalibOptions
See the vignettes for examples.
Value
Depending on the class of InputsModel
argument (respectively InputsModel
and GRiwrmInputsModel
object), the returned value is respectively:
a
InputsCrit
object (See airGR::CreateInputsCrit)a
GRiwrmInputsCrit
object which is a list ofInputsCrit
objects with one item per modeled sub-catchment