pEnvelope: Create an Envelope in Parallel
In aproudian2/rapt: Atom Probe Tomography Analysis

pEnvelope

R Documentation

Create an Envelope in Parallel

Create an Envelope in Parallel

pEnvelope(cl, X, fun = K3est, nsim = 99, nrank = 1, ..., simulate = NULL)

`cl`	A "cluster" object (e.g. as generated by `makeCluster`)
`X`	A point pattern (object of class "pp3")
`fun`	Function that computes the desired summary statistic for a 3D point pattern.
`nsim`	Number of simulated point patterns to be generated when computing the envelopes.
`nrank`	Integer. Rank of the envelope value amongst the `nsim` simulated values. A rank of 1 means that the minimum and maximum simulated values will be used.
`...`	Extra arguments passed to `fun`
`simulate`	Optional. Specifies how to generate the simulated point patterns. If `simulate` is an expression in the R language, then this expression will be evaluated `nsim` times, to obtain `nsim` point patterns which are taken as the simulated patterns from which the envelopes are computed. If `simulate` is a function, then this function will be repeatedly applied to the point pattern `X` to obtain `nsim` simulated patterns. If `simulate` is a list of point patterns, then the entries in this list will be treated as the simulated patterns from which the envelopes are computed. Currently, only a list of point patterns is accepted.

A function value table (object of class "fv") which can be plotted directly. See envelope for further details.