RandomFields (version 3.1.12)

RMuser: User Defined Function

Description

RMuser allows for a user defined covariance function, variogram model, or arbitrary function.

RMuser is very slow -- users should avoid this model whenever possible.

Usage

RMuser(type, domain, isotropy, vdim, beta,
       varnames = c("x", "y", "z", "T"), fctn, fst, snd, envir,  
       var, scale, Aniso, proj)

Arguments

type

See RMmodelgenerator for the range of values of the arguments.

Default: "shape function".

domain

See RMmodelgenerator for the range of values of the arguments.

Default: XONLY.

isotropy

See RMmodelgenerator for the range of values of the arguments. Default:

• 'isotropic'iftypeequals'tail correlation

vdim

multivariability. Default: vdim is identified from beta if given; otherwise the default value is 1.

beta

a fixed matrix that is multiplied to the return value of the given function; the dimension must match. Defining a vector valued function and beta as a vector, an arbitrary linear model can be defined. Estimation of beta

varnames

Just the names of the variables. More variable names might be given here than used in the function. See Detail for the interpretation of variables.

fctn, fst, snd

a user defined function and its first, second and third derivative, given as quote(myfunction(x)) or as quote(myfunction(x, y)), see Details an Examples below.

envir

the environment where the given function shall be evaluated

var,scale,Aniso,proj

optional arguments; same meaning for any RMmodel. If not passed, the above covariance function remains unmodified.

Value

• RMuser returns an object of class RMmodel.

Details

Primarily, a function is expected that depends on a vector whose components, $x, y, z, T$, are given separately as scalar quantities. Alternatively, the function might depend only on the first argument given by varnames.

A kernel should depend on the first two arguments given by varnames.

See Also

RMcovariate, RMfixcov, RFfit, RMmodelgenerator RMmodel, RFsimulate, RC_ISONAMES, RC_DOMAIN_NAMES

Examples

RFoptions(seed=0) ## *ANY* simulation will have the random seed 0; set
##                   RFoptions(seed=NA) to make them all random again
StartExample()

## Alternatively to 'model <- RMexp()' one may define the following
## (which is, however, much slower and cannot use all features of
## RandomFields)
if (RFoptions()$general$storing) {
  cat("This examples requires 'RFoptions(storing=FALSE)', what is set now.\n");
  RFoptions(storing=FALSE)
}
## user-defined exponential covariance model
model <- RMuser(type="positive definite", domain="single variable",
                iso="isotropic", fctn=exp(-x))
x <- y <- seq(1, 10, len=100)
plot(model)
z <- RFsimulate(model, x=x, y=y)
plot(z)

## the kernel, which is the scalar product (not programmed (yet) in
## RandomFields) %to do
model <- RMnugget(var=1e-5) +
         RMuser(type="positive definite", domain="kernel",
                iso="symmetric", fctn=sum(x * y))
x <- y <- seq(1, 10, len=35)
z <- RFsimulate(model, x=x, y=y, n=6, svdtol=1e-9) 
plot(z)
FinalizeExample()