vpc.calc {RGeostats}R Documentation

Calculate the VPC matrix

Description

Calculate the VPC matrix

Usage

vpc.calc(db, nx = c(1, 1), nz = 30, flag.indicator = FALSE,
        width = NA, range = NA)

Arguments

db

The db-class containing the data information. This can be directly the facies indicators (with Locator Z) or a Facies variable which can be transformed into Facies indicators using 'flag.indicator'.

nx

Array giving the two first dimensions of the VPC matrix. By default, these values are set to 1 which corresponds to a single global VPC.

nz

Third first dimensions of the VPC matrix.

flag.indicator

When TRUE, the input variable (locator Z) which must be unique is converted automatically into Facies indicators.

width

When defined (and positive), this option launches a smoothing filtering of the VPC. This parameter defines the radius of the Gaussian convolution kernel which will be applied.

range

When defined (and positive), this option launches a smoothing filtering of the VPC. This parameter defines the range of the Gaussian convolution kernel which will be applied.

Value

The function returns a db-class structure which contains the VPC matrix. It is organized as a 3-D grid which covers the field and whose subdivision in cells is given by 'nx' (for the 2 first dimensions) and 'nz' (for the third one).

[Package RGeostats version 14.0.10 Index]