Package de.unijena.cheminf.clustering.art2a

Class Art2aEuclidTask

java.lang.Object

de.unijena.cheminf.clustering.art2a.Art2aEuclidTask

All Implemented Interfaces:

Callable<Art2aEuclidResult>

public class Art2aEuclidTask
extends Object
implements Callable<Art2aEuclidResult>

Callable that wraps an Art2aEuclidKernel instance where the call() method returns an Art2aEuclidResult object. See Art2aEuclidKernel for further details.

Constructor Summary

Constructors

Constructor	Description
Art2aEuclidTask(float[][] aDataMatrix, float aVigilance, int aMaximumNumberOfClusters, boolean anIsDataPreprocessing)	Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.1), LEARNING_PARAMETER (= 0.01), DEFAULT_OFFSET_FOR_CONTRAST_ENHANCEMENT (= 0.5) and RANDOM_SEED (= 1).
Art2aEuclidTask(float[][] aDataMatrix, float aVigilance, int aMaximumNumberOfClusters, int aMaximumNumberOfEpochs, float aConvergenceThreshold, float aLearningParameter, float anOffsetForContrastEnhancement, long aRandomSeed, boolean anIsDataPreprocessing)	Constructor.
Art2aEuclidTask(PreprocessedArt2aEuclidData aPreprocessedArt2aEuclidData, float aVigilance, int aMaximumNumberOfClusters)	Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.1), LEARNING_PARAMETER (= 0.01) and RANDOM_SEED (= 1).
Art2aEuclidTask(PreprocessedArt2aEuclidData aPreprocessedArt2aEuclidData, float aVigilance, int aMaximumNumberOfClusters, int aMaximumNumberOfEpochs, float aConvergenceThreshold, float aLearningParameter, long aRandomSeed)	Constructor.

Method Summary

Modifier and Type	Method	Description
Art2aEuclidResult	call()	Performs the clustering process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Art2aEuclidTask

public Art2aEuclidTask(float[][] aDataMatrix,
 float aVigilance,
 int aMaximumNumberOfClusters,
 int aMaximumNumberOfEpochs,
 float aConvergenceThreshold,
 float aLearningParameter,
 float anOffsetForContrastEnhancement,
 long aRandomSeed,
 boolean anIsDataPreprocessing)
                throws IllegalArgumentException

Constructor.

Parameters:

aDataMatrix - Data matrix with data row vectors (IS NOT CHANGED)

aVigilance - Vigilance parameter (must be in interval (0,1))

aMaximumNumberOfClusters - Maximum number of clusters (must be in interval [2, number of data row vectors of aDataMatrix])

aMaximumNumberOfEpochs - Maximum number of epochs for training (must be greater zero)

aConvergenceThreshold - Convergence threshold for cluster centroid similarity (must be in interval (0,1))

aLearningParameter - Learning parameter (must be in interval (0,1))

anOffsetForContrastEnhancement - Offset for contrast enhancement (must be greater zero)

aRandomSeed - Random seed value for random number generator (must be greater zero)

anIsDataPreprocessing - True: Data preprocessing is performed, false: Otherwise.

Throws:

IllegalArgumentException - Thrown if an argument is illegal

Art2aEuclidTask

public Art2aEuclidTask(float[][] aDataMatrix,
 float aVigilance,
 int aMaximumNumberOfClusters,
 boolean anIsDataPreprocessing)
                throws IllegalArgumentException

Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.1), LEARNING_PARAMETER (= 0.01), DEFAULT_OFFSET_FOR_CONTRAST_ENHANCEMENT (= 0.5) and RANDOM_SEED (= 1).

Parameters:

aDataMatrix - Data matrix with data row vectors (IS NOT CHANGED)

aVigilance - Vigilance parameter (must be in interval (0,1))

aMaximumNumberOfClusters - Maximum number of clusters (must be in interval [2, number of data row vectors of aDataMatrix])

anIsDataPreprocessing - True: Data preprocessing is performed, false: Otherwise.

Throws:

IllegalArgumentException - Thrown if argument is illegal

Art2aEuclidTask

public Art2aEuclidTask(PreprocessedArt2aEuclidData aPreprocessedArt2aEuclidData,
 float aVigilance,
 int aMaximumNumberOfClusters,
 int aMaximumNumberOfEpochs,
 float aConvergenceThreshold,
 float aLearningParameter,
 long aRandomSeed)
                throws IllegalArgumentException

Constructor.

Parameters:

aPreprocessedArt2aEuclidData - PreprocessedData data object created by method Art2aEuclidKernel.getPreprocessedData()

aVigilance - Vigilance parameter (must be in interval (0,1))

aMaximumNumberOfClusters - Maximum number of clusters (must be in interval [2, number of data row vectors of aDataMatrix])

aMaximumNumberOfEpochs - Maximum number of epochs for training (must be greater zero)

aConvergenceThreshold - Convergence threshold for cluster centroid similarity (must be in interval (0,1))

aLearningParameter - Learning parameter (must be in interval (0,1))

aRandomSeed - Random seed value for random number generator (must be greater zero)

Throws:

IllegalArgumentException - Thrown if an argument is illegal

Art2aEuclidTask

public Art2aEuclidTask(PreprocessedArt2aEuclidData aPreprocessedArt2aEuclidData,
 float aVigilance,
 int aMaximumNumberOfClusters)
                throws IllegalArgumentException

Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.1), LEARNING_PARAMETER (= 0.01) and RANDOM_SEED (= 1).

Parameters:

aPreprocessedArt2aEuclidData - PreprocessedData object created by method Art2aEuclidKernel.getPreprocessedData()

aVigilance - Vigilance parameter (must be in interval (0,1))

aMaximumNumberOfClusters - Maximum number of clusters (must be in interval [2, number of data row vectors of aDataMatrix])

Throws:

IllegalArgumentException - Thrown if argument is illegal

Method Details

call

public Art2aEuclidResult call()

Performs the clustering process. Note: Parallel Rho winner evaluation is disabled.

Specified by:

call in interface Callable<Art2aEuclidResult>

Returns:

Clustering result or null if clustering process could not be performed.