An error occurred while loading the file. Please try again.
-
Guillaume Perréal authored5b85f101
% Generated by roxygen2: do not edit by hand% Please edit documentation in R/CreateCalibOptions.R\encoding{UTF-8}\name{CreateCalibOptions}\alias{CreateCalibOptions}\title{Creation of the CalibOptions object required to the Calibration functions}\usage{CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_HBAN, FUN_TRANSFO = NULL, OptimParam = NULL, FixedParam = NULL, SearchRanges = NULL, StartParam = NULL, StartParamList = NULL, StartParamDistrib = NULL)}\arguments{\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)}\item{FUN_CALIB}{(optional) [function] calibration algorithm function (e.g. Calibration_HBAN, Calibration_optim), default=Calibration_HBAN}\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined}\item{OptimParam}{(optional) [boolean] vector of booleans indicating which parameters must be optimised (NParam columns, 1 line)}\item{FixedParam}{(optional) [numeric] vector giving the values to allocate to non-optimised parameter values (NParam columns, 1 line)}\item{SearchRanges}{(optional) [numeric] matrix giving the ranges of real parameters (NParam columns, 2 lines)\tabular{llllll}{ \tab [X1] \tab [X2] \tab [X3] \tab [...] \tab [Xi] \cr [1,] \tab 0 \tab -1 \tab 0 \tab ... \tab 0.0 \cr [2,] \tab 3000 \tab +1 \tab 100 \tab ... \tab 3.0 \cr}}\item{StartParam}{(optional) [numeric] vector of parameter values used to start global search calibration procedure (e.g. Calibration_optim)\tabular{llllll}{ \tab [X1] \tab [X2] \tab [X3] \tab [...] \tab [Xi] \cr \tab 1000 \tab -0.5 \tab 22 \tab ... \tab 1.1 \cr}}\item{StartParamList}{(optional) [numeric] matrix of parameter sets used for grid-screening calibration procedure (values in columns, sets in line)\tabular{llllll}{ \tab [X1] \tab [X2] \tab [X3] \tab [...] \tab [Xi] \cr [set1] \tab 800 \tab -0.7 \tab 25 \tab ... \tab 1.0 \cr [set2] \tab 1000 \tab -0.5 \tab 22 \tab ... \tab 1.1 \cr [...] \tab ... \tab ... \tab ... \tab ... \tab ... \cr [set n] \tab 200 \tab -0.3 \tab 17 \tab ... \tab 1.0 \cr}}\item{StartParamDistrib}{(optional) [numeric] matrix of parameter values used for grid-screening calibration procedure (values in columns, percentiles in line) \cr\tabular{llllll}{ \tab [X1] \tab [X2] \tab [X3] \tab [...] \tab [Xi] \cr [value1] \tab 800 \tab -0.7 \tab 25 \tab ... \tab 1.0 \cr [value2] \tab 1000 \tab NA \tab 50 \tab ... \tab 1.2 \cr [value3] \tab 1200 \tab NA \tab NA \tab ... \tab 1.6 \cr}}}\value{[list] object of class \emph{CalibOptions} containing the data required to evaluate the model outputs; it can include the following: \tabular{ll}{ \emph{$OptimParam } \tab [boolean] vector of booleans indicating which parameters must be optimised \cr \emph{$FixedParam } \tab [numeric] vector giving the values to allocate to non-optimised parameter values \cr \emph{$SearchRanges } \tab [numeric] matrix giving the ranges of real parameters \cr \emph{$StartParam } \tab [numeric] vector of parameter values used to start global search calibration procedure \cr \emph{$StartParamList } \tab [numeric] matrix of parameter sets used for grid-screening calibration procedure \cr \emph{$StartParamDistrib} \tab [numeric] matrix of parameter values used for grid-screening calibration procedure \cr }}\description{Creation of the CalibOptions object required to the Calibration functions.}\details{Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not included in the package must create their own CalibOptions object accordingly.7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
}
\examples{
## load of catchment data
require(airGR)
data(L0123001)
## preparation of InputsModel object
InputsModel <- CreateInputsModel(FUN_MOD=RunModel_GR4J,DatesR=BasinObs$DatesR,
Precip=BasinObs$P,PotEvap=BasinObs$E)
## calibration period selection
Ind_Run <- seq(which(format(BasinObs$DatesR,format="\%d/\%m/\%Y \%H:\%M")=="01/01/1990 00:00"),
which(format(BasinObs$DatesR,format="\%d/\%m/\%Y \%H:\%M")=="31/12/1999 00:00"))
## preparation of RunOptions object
RunOptions <- CreateRunOptions(FUN_MOD=RunModel_GR4J,InputsModel=InputsModel,IndPeriod_Run=Ind_Run)
## calibration criterion: preparation of the InputsCrit object
InputsCrit <- CreateInputsCrit(FUN_CRIT=ErrorCrit_NSE,InputsModel=InputsModel,
RunOptions=RunOptions,Qobs=BasinObs$Qmm[Ind_Run])
## preparation of CalibOptions object
CalibOptions <- CreateCalibOptions(FUN_MOD=RunModel_GR4J,FUN_CALIB=Calibration_HBAN)
## calibration
OutputsCalib <- Calibration(InputsModel=InputsModel,RunOptions=RunOptions,InputsCrit=InputsCrit,
CalibOptions=CalibOptions,FUN_MOD=RunModel_GR4J,FUN_CRIT=ErrorCrit_NSE,
FUN_CALIB=Calibration_HBAN)
## simulation
Param <- OutputsCalib$ParamFinalR
OutputsModel <- RunModel(InputsModel=InputsModel,RunOptions=RunOptions,
Param=Param,FUN=RunModel_GR4J)
## results preview
plot_OutputsModel(OutputsModel=OutputsModel,Qobs=BasinObs$Qmm[Ind_Run])
## efficiency criterion: Nash-Sutcliffe Efficiency
InputsCrit <- CreateInputsCrit(FUN_CRIT=ErrorCrit_NSE,InputsModel=InputsModel,
RunOptions=RunOptions,Qobs=BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_NSE(InputsCrit=InputsCrit,OutputsModel=OutputsModel)
cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\\n",sep=""))
## efficiency criterion: Kling-Gupta Efficiency
InputsCrit <- CreateInputsCrit(FUN_CRIT=ErrorCrit_KGE,InputsModel=InputsModel,
RunOptions=RunOptions,Qobs=BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_KGE(InputsCrit=InputsCrit,OutputsModel=OutputsModel)
cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\\n",sep=""))
}
\author{
Laurent Coron (June 2014)
}
\seealso{
\code{\link{Calibration}}, \code{\link{RunModel}}
}