pF3est-deprecated: Perform F3est on random relabelings in parallel

In aproudian2/rapt: Atom Probe Tomography Analysis

Perform F3est on random relabelings in parallel

Description

pF3est first randomly relabels a specified percentage of points from the original pp3 object. It then performs a 3D F function test (F3est) on these selected points. It repeats this as many times as specified. These tests are run in parallel to increase computation speed.

Arguments

perc	The fraction of points to select randomly each time out of the original pp3 object. Number between 0 and 1.
pattern	The original pp3 object.
nEvals	The number of random relabelings and that should be performed.
rmax	See F3est. Maximum radius to be calculated for F3est.
nrval	See F3est. Number of radii that F3est should be calculated at.
correction	Either "rs", "km", or "cs" edge correction.
anom	Whether or not to retun the anomaly results. TRUE or FALSE. See section below for more info.
toSub	The numeric vector of data to subtract for the "anom" pF3est. Only used when anom = TRUE. See below for more info.
cores	Number of cores to use for parallel processing. If no parallel desired, set to 1. If NULL, will automatically set to the number of cores available on the machine.

Value

For anom = FALSE

Returns a matrix containing the data from the all of the F3est runs on different re-labelings. Can plot data using envPlot.

For anom = TRUE

A list of: [1] Matrix of data for all relabelings. Can be plotted using envPlot. [2] Vector containing the values that were subtracted from the results at each r value. Can be used to subtract from another set of envelopes for comparison. [3] rmax used in the calculation. [4] nrval used in the calculation.

Edge Corrections

See book availible at http://spatstat.org/book.html for more info on these edge corrections.

Reduced Sample - "rs"

Kaplan-Meier - "km"

Chiu-Stoyan (aka Hanisch) - "cs"

Anomaly F3est

When anom = TRUE, the function returns the anomaly F3est.This means that it returns the F3est results with the 50th percentile subtracted out. This centers envelopes around zero.

toSub is an argumet to be paired with anom = TRUE. If NULL, use the 50th percentile of the calculated set of F3est envelopes to subtract off. Otherwise, use the second, [2], entry in the list returned from this same function. This is how to compare envelope calculations from different point patterns. You must subtract the same values from both data sets. toSub allows you to input the values that were subtracted from a previous set of envelopes, for comparison.

See Also

rapt-deprecated

aproudian2/rapt documentation built on Dec. 15, 2022, 4:24 a.m.