clusterSPkdba {sarp.snowprofile.alignment} | R Documentation |
K-dimensional barycentric average clustering for snow profiles
Description
K-dimensional barycentric average clustering for snow profiles
Usage
clusterSPkdba(
SPx,
k,
config = clusterSPconfig(type = "kdba"),
centers = "centroids",
distmat = NULL,
keepSPx = TRUE
)
Arguments
SPx |
a sarp.snowprofile::snowprofileSet to be clustered |
k |
number of desired cluster numbers |
config |
a list providing the necessary hyperparameters. Use clusterSPconfig function with |
centers |
type of center to determine, either |
distmat |
a precomputed distance matrix of class dist (only used if |
keepSPx |
append the snowprofileSet to the output? |
Value
a list of class clusterSP
containing:
-
clustering
: vector of integers (from 1:k) indicating the cluster to which each point is allocated -
centroids
: snowprofileSet containing the centroid profile for each cluster (if calculated) -
clusters_history
: matrix with history of clustering over iterations -
iccentroids
: initial condition centroids -
niterations
: number of iterations -
converged
: did the algorithm converge? -
SPx
: a copy of the input snowprofileSet (ifkeepSPx = TRUE
)
Author(s)
fherla shorton
See Also
Examples
this_example_runs_too_long <- TRUE
if (!this_example_runs_too_long) { # exclude from cran checks
cl_kdba <- clusterSPkdba(SPgroup2, k = 2)
plot(cl_kdba)
}