GetRegisterInfo: Internal information

Description

The function returns internal information about the simulation of a random field

Usage

GetRegisterInfo(register=0, ignore.active = FALSE, max.elements=10^6)
GetModelInfo(register=0)

Arguments

-2, -1, 0:9; place where intermediate calculations are stored; the numbers 0:9 are aliases for 10 internal registers, see also GaussRF

ignore.active

logical. If FALSE and the register has non-active flag (because of an error or it is deleted) then a list is returned that contains only the element active=FALSE. Otherwise, the full list is always returned.

max.elements

integer; since GetRegisterInfo might be a dump of simulation that needs a huge amount of memory and since all entries are copied, the maximal amount of available memory might be easily exceeded. Therefore, only the size

Value

List of internal information is returned.

Details

GetRegisterInfo(register, ignore.active=TRUE) is useful for debugging and specialists' need to control the algorithm, see the examples in RFparameters and GaussRF. If RFparameters()$Storage=FALSE then values of the internal registers are not kept if GaussRF or DoSimulateRF has been called. Hence GetRegisterInfo cannot provide any information.

GetModelInfo returns the partial information on the internal model structure. It allows for register==-1 returning the model structure for the last use of CovarianceFct or Variogram or similar commands. register==-2 is for internal use only.

Examples

Run this code

# lets regard at a non-initialised register first:
DeleteAllRegisters()
str(GetRegisterInfo(0))

# now, a register that has successfully initialised
try(GaussRF(1:4, grid=TRUE, model="exp", param=c(1,2,3,4), Storing=TRUE))
str(GetRegisterInfo(0))

# finally, a register that could not be successfully initialised
try(GaussRF(runif(4), grid=FALSE, model="exp", param=c(1,2,3,4),
            me="ci", Storing=TRUE))
str(GetRegisterInfo(0, TRUE))