edge.effect {RGeostats}R Documentation

Calculate and Visualize the Edge Effect

Description

Calculate and Visualize the Edge Effect

Usage

edge.effect(db, cuts,
            dirvect = NA, lag = NA, toldis = 0.5, tolang = NA, bench = 0,
            cylrad = 0, nlag = NA, breaks = NA, opt.code = 0, tolcode = 0,
            flag.orient=1, title = NA, xlab = NA, ylab = NA, cols = NA, ...)

Arguments

db

The db-class containing the data information used to calculate the experimental variogram. There must be a single variable defined as Z-locator. The indicator of the different classes are calculated first and their variograms are calculated. The edge effect functions are derived from there.

cuts

The array of cutoffs.

dirvect

The directions in which the variogram must be calculated. For more information, refer to get.directions

lag

Array containing the distance lags for each calculation direction. If no corresponding lag is not defined, a default lag is calculated so that the maximum distance is equal to half of the field diagonal. For one distance, if the lag is not defined, it is set to the default lag.

toldis

Tolerance on the distance, expressed as a proportion of the lag. This parameter is only used in the case of regular lags.

tolang

Array containing the angular tolerance for each calculation direction. If no angular tolerance is not defined, a default tolerance is calculated as one half of the angle. For one direction, if the angular tolerance is not defined, it is set to the default tolerance.

bench

Array containing the bench separation tolerance for each calculation direction. When bench is defined and positive, a pair is discarded if the separation distance between the two points along the third axis is larger than 'bench'.

cylrad

Array containing the cylrad tolerance for each calculation direction. When specified and positive, a pair is discarded if the separation distance in the plane orthogonal to the calculation distance is larger than 'cylrad'.

nlag

Array containing the number of lags for each calculation direction. If not defined, the defaulted number of lags is set to 10. For one direction, if the number of lags is not defined, it is set to 10.

breaks

Vector giving the boundaries of irregular distance lags. For multidrectional computations, breaks is either: a vector (The breaks are then the same for all directions) a list of vectors of the breaks for each direction. If provided, nlag is adapted to the breaks. Intervals are open left and closed right (e.g ]0;15]).

opt.code

Array containing the option concerning the use of the code for each direction. This option defines the strategy for the code usage when considering a pair of samples:

  • 0 : a pair of samples is selected whatever their codes (if active)

  • 1 : a pair is retained if the code is active in the data base and the codes of the two samples are closer than tolcode

  • 2 : a pair is retained only if the codes of the two samples are different

tolcode

Array giving the maximum distance between the codes of the two samples for each direction.

flag.orient

This argument describes the type of calculations to be performed:

  • 1 For the edge effect upwards

  • -1 For the edge effect downwards

  • 0 For the variogram of indicators normalized by their proportions

title

Title for the plot. This title will be concantenated with "Upwards" or "Downwards" according to the argument 'flag.updwards'.

xlab

Name of the label along the X-axis

ylab

Name of the label along the Y-axis

cols

Array of colors used to represent the Edge Effect curves.

...

Additional arguments passed to plot.

Value

Not used.


[Package RGeostats version 11.1.1 Index]