renaming, refactoring

[epclust.git] / epclust / R / clustering.R

# Cluster one full task (nb_curves / ntasks series)
clusteringTask = function(K1, K2, WER, nb_series_per_chunk, indices_tasks, ncores_clust)
{
	cl_clust = parallel::makeCluster(ncores_clust)
	#parallel::clusterExport(cl=cl_clust, varlist=c("fonctions_du_package"), envir=environment())
	indices_clust = indices_task[[i]]
	repeat
	{
		nb_workers = max( 1, round( length(indices_clust) / nb_series_per_chunk ) )
		indices_workers = list()
		for (i in 1:nb_workers)
		{
			upper_bound = ifelse( i<nb_workers,
				min(nb_series_per_chunk*i,length(indices_clust)), length(indices_clust) )
			indices_workers[[i]] = indices_clust[(nb_series_per_chunk*(i-1)+1):upper_bound]
		}
		indices_clust = parallel::parLapply(cl, indices_workers, clusterChunk, K1, K2*(WER=="mix"))
		if ((WER=="end" && length(indices_clust)==K1) || (WER=="mix" && length(indices_clust)==K2))
			break
	}
	parallel::stopCluster(cl_clust)
	unlist(indices_clust)
}

# Cluster a chunk of series inside one task (~max nb_series_per_chunk)
clusterChunk = function(indices, K1, K2)
{
	coeffs = getCoeffs(indices)
	cl = computeClusters(as.matrix(coeffs[,2:ncol(coeffs)]), K1, diss=FALSE)
	if (K2 > 0)
	{
		curves = computeSynchrones(cl)
		dists = computeWerDists(curves)
		cl = computeClusters(dists, K2, diss=TRUE)
	}
	indices[cl]
}

# Apply the clustering algorithm (PAM) on a coeffs or distances matrix
computeClusters = function(md, K, diss)
{
	if (!require(cluster, quietly=TRUE))
		stop("Unable to load cluster library")
	cluster::pam(md, K, diss=diss)$id.med
}

# Compute the synchrones curves (sum of clusters elements) from a clustering result
computeSynchrones = function(indices)
{
	colSums( getData(indices) )
}

# Compute the WER distance between the synchrones curves
computeWerDist = function(curves)
{
	if (!require("Rwave", quietly=TRUE))
		stop("Unable to load Rwave library")
	n <- nrow(curves)
	delta <- ncol(curves)
	#TODO: automatic tune of all these parameters ? (for other users)
	nvoice   <- 4
	# noctave = 2^13 = 8192 half hours ~ 180 days ; ~log2(ncol(curves))
	noctave = 13
	# 4 here represent 2^5 = 32 half-hours ~ 1 day
	#NOTE: default scalevector == 2^(0:(noctave * nvoice) / nvoice) * s0 (?)
	scalevector  <- 2^(4:(noctave * nvoice) / nvoice) * 2
	#condition: ( log2(s0*w0/(2*pi)) - 1 ) * nvoice + 1.5 >= 1
	s0=2
	w0=2*pi
	scaled=FALSE
	s0log = as.integer( (log2( s0*w0/(2*pi) ) - 1) * nvoice + 1.5 )
	totnoct = noctave + as.integer(s0log/nvoice) + 1

	# (normalized) observations node with CWT
	Xcwt4 <- lapply(seq_len(n), function(i) {
		ts <- scale(ts(curves[i,]), center=TRUE, scale=scaled)
		totts.cwt = Rwave::cwt(ts,totnoct,nvoice,w0,plot=0)
		ts.cwt = totts.cwt[,s0log:(s0log+noctave*nvoice)]
		#Normalization
		sqs <- sqrt(2^(0:(noctave*nvoice)/nvoice)*s0)
		sqres <- sweep(ts.cwt,MARGIN=2,sqs,'*')
		sqres / max(Mod(sqres))
	})

	Xwer_dist <- matrix(0., n, n)
	fcoefs = rep(1/3, 3) #moving average on 3 values (TODO: very slow! correct?!)
	for (i in 1:(n-1))
	{
		for (j in (i+1):n)
		{
			#TODO: later, compute CWT here (because not enough storage space for 32M series)
			#      'circular=TRUE' is wrong, should just take values on the sides; to rewrite in C
			num <- filter(Mod(Xcwt4[[i]] * Conj(Xcwt4[[j]])), fcoefs, circular=TRUE)
			WX <- filter(Mod(Xcwt4[[i]] * Conj(Xcwt4[[i]])), fcoefs, circular=TRUE)
			WY <- filter(Mod(Xcwt4[[j]] * Conj(Xcwt4[[j]])), fcoefs, circular=TRUE)
			wer2    <- sum(colSums(num)^2) / sum( sum(colSums(WX) * colSums(WY)) )
			Xwer_dist[i,j] <- sqrt(delta * ncol(Xcwt4[[1]]) * (1 - wer2))
			Xwer_dist[j,i] <- Xwer_dist[i,j]
		}
	}
	diag(Xwer_dist) <- numeric(n)
	Xwer_dist
}