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, 
      nmini = 1, nmaxi = 1, nsect = 1, nsmax = 1, 
      width = 1, radius = 1, skip=1, rotmat=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.

flag.rotation

This parameter is specific for the an anisotropic angular sector search in Moving Neighborhood. When TRUE, the Neigborhood ellipsoid is rotated.

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.

rotmat

Rotation matrix which defines the main axes of the rotation ellipsoid.

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 11.1.1 Index]