create_ClusterSystem: Create dosimetric cluster system

In RLumCarlo: Monte-Carlo Methods for Simulating Luminescence Phenomena

Create dosimetric cluster system

Description

In order to allow interaction of an spatial a correlation clusters in RLumCarlo, first a dosimetric system needs to be created in a three-dimensional space, which is the purpose of this function.

Usage

create_ClusterSystem(n = 100, h = 0.5, plot = FALSE, ...)

Arguments

n	numeric (with default): number of clusters to be created in an arbitrary 3-dimensional cube. x, y, z distances range between 0 and 1.
h	numeric (with default): numeric scalar the cut the cluster tree using stats::cutree. The number must range between 0 and 1.
plot	logical (with default): enables/disables plot output
...	further arguments to be passed to the plot output

Value

The function returns a list of class RLumCarlo_clusters consisting of numeric vector of cluster groups and a matrix of the cluster positions in the arbitrary space. If plot = TRUE the system is displayed using scatterplot3d::scatterplot3d

Function version

0.1.0

How to cite

Kreutzer, S., 2022. create_ClusterSystem(): Create dosimetric cluster system. Function version 0.1.0. In: Friedrich, J., Kreutzer, S., Pagonis, V., Schmidt, C., 2022. RLumCarlo: Monte-Carlo Methods for Simulating Luminescence Phenomena. R package version 0.1.9. https://CRAN.R-project.org/package=RLumCarlo

Author(s)

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany)

See Also

stats::dist, stats::hclust, stats::cutree

Examples

create_ClusterSystem(n = 10, plot = TRUE)

RLumCarlo documentation built on Aug. 9, 2022, 1:06 a.m.