# naginterfaces.library.rand.field_​2d_​generate¶

naginterfaces.library.rand.field_2d_generate(ns, s, m, lam, rho, statecomm)[source]

field_2d_generate produces realizations of a stationary Gaussian random field in two dimensions, using the circulant embedding method. The square roots of the eigenvalues of the extended covariance matrix (or embedding matrix) need to be input, and can be calculated using field_2d_user_setup() or field_2d_predef_setup().

For full information please refer to the NAG Library document for g05zs

https://www.nag.com/numeric/nl/nagdoc_27.1/flhtml/g05/g05zsf.html

Parameters
nsint, array-like, shape

The number of sample points to use in each direction, with sample points in the -direction and sample points in the -direction. The total number of sample points on the grid is, therefore, . This must be the same value as supplied to field_2d_user_setup() or field_2d_predef_setup() when calculating the eigenvalues of the embedding matrix.

sint

, the number of realizations of the random field to simulate.

mint, array-like, shape

Indicates the size, , of the embedding matrix as returned by field_2d_user_setup() or field_2d_predef_setup(). The embedding matrix is a block circulant matrix with circulant blocks. is the size of each block, and is the number of blocks.

lamfloat, array-like, shape

Contains the square roots of the eigenvalues of the embedding matrix, as returned by field_2d_user_setup() or field_2d_predef_setup().

rhofloat

Indicates the scaling of the covariance matrix, as returned by field_2d_user_setup() or field_2d_predef_setup().

statecommdict, RNG communication object, modified in place

RNG communication structure.

This argument must have been initialized by a prior call to init_repeat() or init_nonrepeat().

Returns
zfloat, ndarray, shape

Contains the realizations of the random field. The th realization (where ) of the random field on the two-dimensional grid is stored in , for and for . The points are returned in and by field_2d_user_setup() or field_2d_predef_setup().

Raises
NagValueError
(errno )

On entry, .

Constraint: , .

(errno )

On entry, .

Constraint: .

(errno )

On entry, , and .

Constraints: , for .

(errno )

On entry, at least one element of was negative.

Constraint: all elements of must be non-negative.

(errno )

On entry, .

Constraint: .

(errno )

On entry, [‘state’] vector has been corrupted or not initialized.

Notes

A two-dimensional random field in is a function which is random at every point , so is a random variable for each . The random field has a mean function and a symmetric positive semidefinite covariance function . is a Gaussian random field if for any choice of and , the random vector follows a multivariate Normal distribution, which would have a mean vector with entries and a covariance matrix with entries . A Gaussian random field is stationary if is constant for all and for all and hence we can express the covariance function as a function of one variable: . is known as a variogram (or more correctly, a semivariogram) and includes the multiplicative factor representing the variance such that .

The functions field_2d_user_setup() or field_2d_predef_setup() along with field_2d_generate are used to simulate a two-dimensional stationary Gaussian random field, with mean function zero and variogram , over a domain , using an equally spaced set of points; points in the -direction and points in the -direction. The problem reduces to sampling a Gaussian random vector of size , with mean vector zero and a symmetric covariance matrix , which is an block Toeplitz matrix with Toeplitz blocks of size . Since is in general expensive to factorize, a technique known as the circulant embedding method is used. is embedded into a larger, symmetric matrix , which is an block circulant matrix with circulant bocks of size , where and . can now be factorized as , where is the two-dimensional Fourier matrix ( is the complex conjugate of ), is the diagonal matrix containing the eigenvalues of and . is known as the embedding matrix. The eigenvalues can be calculated by performing a discrete Fourier transform of the first row (or column) of and multiplying by , and so only the first row (or column) of is needed – the whole matrix does not need to be formed.

The symmetry of as a block matrix, and the symmetry of each block of , depends on whether the covariance function is even or not. is even if for all , and uneven otherwise (in higher dimensions, can be even in some coordinates and uneven in others, but in two dimensions is either even in both coordinates or uneven in both coordinates). If is even then is a symmetric block matrix and has symmetric blocks; if is uneven then is not a symmetric block matrix and has non-symmetric blocks. In the uneven case, and are set to be odd in order to guarantee symmetry in .

As long as all of the values of are non-negative (i.e., is positive semidefinite), is a covariance matrix for a random vector which has ‘blocks’ of size . Two samples of can now be simulated from the real and imaginary parts of , where and have elements from the standard Normal distribution. Since , this calculation can be done using a discrete Fourier transform of the vector . Two samples of the random vector can now be recovered by taking the first elements of the first blocks of each sample of – because the original covariance matrix is embedded in , will have the correct distribution.

If is not positive semidefinite, larger embedding matrices can be tried; however if the size of the matrix would have to be larger than , an approximation procedure is used. See the documentation of field_2d_user_setup() or field_2d_predef_setup() for details of the approximation procedure.

field_2d_generate takes the square roots of the eigenvalues of the embedding matrix , and its size vector , as input and outputs realizations of the random field in .

One of the initialization functions init_repeat() (for a repeatable sequence if computed sequentially) or init_nonrepeat() (for a non-repeatable sequence) must be called prior to the first call to field_2d_generate.

References

Dietrich, C R and Newsam, G N, 1997, Fast and exact simulation of stationary Gaussian processes through circulant embedding of the covariance matrix, SIAM J. Sci. Comput. (18), 1088–1107

Schlather, M, 1999, Introduction to positive definite functions and to unconditional simulation of random fields, Technical Report ST 99–10, Lancaster University

Wood, A T A and Chan, G, 1994, Simulation of stationary Gaussian processes in , Journal of Computational and Graphical Statistics (3(4)), 409–432