R: Initialize a Neighborhood Structure

neigh.create {RGeostats}

R Documentation

Initialize a Neighborhood Structure

Description

Initialize a new neigh-class

Usage

neigh.create(ndim = 2, type = 2, 
      flag.sector = FALSE, flag.aniso = FALSE, flag.rotation = FALSE, 
      flag.continuous = FALSE, nmini = 1, nmaxi = 1, nsect = 1, nsmax = 1, 
      width = 1, radius = 1, skip=1, dist.cont = 1, rotmat=NA, angles=NA,
      radimg=NA)

Arguments

`ndim`	Space Dimension
`type`	Type of the Neighborhood, chosen among the following possibilities: 0 : Unique Neighborhood 1 : Bench Neighborhood 2 : Moving Neighborhood 3 : Image Neighborhood
`flag.sector`	This parameter is specific for the Moving Neighborhood. When TRUE, the Moving Neighborhood search is performed by angular sectors
`flag.aniso`	This parameter is specific for the Angular sector search in Moving Neighborhood. When TRUE, the neighborhood ellipsoid is anisotropic. This flag may be updated automatically according to the definition of 'radius' argument: a warning is issued.
`flag.rotation`	This parameter is specific for the an anisotropic angular sector search in Moving Neighborhood. When TRUE, the Neigborhood ellipsoid is rotated. This flag may be updated automatically according to the definition of 'rotmat' argument: a warning is issued.
`flag.continuous`	When switched ON, the continuous option is switched ON. For more information, see: Rivoirard, J., and Romary, T. (2011) Continuity for Kriging with Moving Neighborhood. Mathematical Geosciences 43 (4) pp 469-481.
`nmini`	This parameter is specific for the Moving Neighborhood. Minimum number of points in the Neighborhood.
`nmaxi`	This parameter is specific for the Moving Neighborhood. Maximum number of points in the Neighborhood.
`nsect`	This parameter is specific for the Angular sector search in Moving Neighborhood. Number of points in each angular sector.
`nsmax`	This parameter is specific for the Angular sector search in Moving Neighborhood. Maximum number of points in each angular sector.
`width`	This parameter is specific for the Bench Neighborhood. Width of the slice around the target point, within which all the data points will belong to the Neighborhood.
`radius`	This parameter is specific for the Moving Neighborhood. It provides the dimensions of the search ellipsoid (or sphere). Its contents is read according to the value of the argument 'flag.aniso'. In the isotropic case, this argument corresponds to the radius of the Neighborhood search (sphere). In the anisotropic case, this argument must be a vector (dimension equal to 'ndim'): the i-th element is the extension of the anisotropic ellipsoid in the i-th direction (after rotation). Otherwise an error is issued.
`skip`	For an image neighborhood, centered on the target grid node, the neighborhood will select only 1 sample out of skip. If skip=1, all the samples of the neighborhood are selected.
`dist.cont`	This parameter is used only for the continuous version of the moving neighborhood. It specifies the normalized distance beyond which the kriging weights will be tapered, as a proportion of the maximum distance. Setting a value of 1 means that this option is discarded.
`rotmat`	Rotation matrix which defines the main axes of the rotation ellipsoid.
`angles`	The Rotation is provided as a set of angles. If both 'angles' and 'rotmat' are provided, 'rotmat' prevails (a message is issued).
`radimg`	Array giving the dimension of the radius of the image nieghborhood along each main direction of the grid. A radius of 0 corresponds to the target grid node alone.

Value

The new neigh-class Class item

[Package RGeostats version 14.0.10 Index]