Package de.unijena.cheminf.clustering.art2a

Class Art2aTask

java.lang.Object
de.unijena.cheminf.clustering.art2a.Art2aTask
All Implemented Interfaces:
Callable<Art2aResult>
public class Art2aTask extends Object implements Callable<Art2aResult>
Callable that wraps an Art2aKernel instance where the call() method returns an Art2aResult object. See Art2aKernel for further details.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Art2aTask(float[][] aDataMatrix, float aVigilance, int aMaximumNumberOfClusters, boolean anIsDataPreprocessing)
    Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.99), LEARNING_PARAMETER (= 0.01), DEFAULT_OFFSET_FOR_CONTRAST_ENHANCEMENT (= 1.0) and RANDOM_SEED (= 1).
    Art2aTask(float[][] aDataMatrix, float aVigilance, int aMaximumNumberOfClusters, int aMaximumNumberOfEpochs, float aConvergenceThreshold, float aLearningParameter, float anOffsetForContrastEnhancement, long aRandomSeed, boolean anIsDataPreprocessing)
    Constructor.
    Art2aTask(PreprocessedArt2aData aPreprocessedArt2aData, float aVigilance, int aMaximumNumberOfClusters)
    Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.99), LEARNING_PARAMETER (= 0.01) and RANDOM_SEED (= 1).
    Art2aTask(PreprocessedArt2aData aPreprocessedArt2aData, float aVigilance, int aMaximumNumberOfClusters, int aMaximumNumberOfEpochs, float aConvergenceThreshold, float aLearningParameter, long aRandomSeed)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Art2aResult
    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

    • Art2aTask

      public Art2aTask(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

    • Art2aTask

      public Art2aTask(float[][] aDataMatrix, float aVigilance, int aMaximumNumberOfClusters, boolean anIsDataPreprocessing) throws IllegalArgumentException
      Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.99), LEARNING_PARAMETER (= 0.01), DEFAULT_OFFSET_FOR_CONTRAST_ENHANCEMENT (= 1.0) 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

    • Art2aTask

      public Art2aTask(PreprocessedArt2aData aPreprocessedArt2aData, float aVigilance, int aMaximumNumberOfClusters, int aMaximumNumberOfEpochs, float aConvergenceThreshold, float aLearningParameter, long aRandomSeed) throws IllegalArgumentException
      Constructor.
      Parameters:
      aPreprocessedArt2aData - PreprocessedData object created by method Art2aKernel.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

    • Art2aTask

      public Art2aTask(PreprocessedArt2aData aPreprocessedArt2aData, float aVigilance, int aMaximumNumberOfClusters) throws IllegalArgumentException
      Constructor with default values for MAXIMUM_NUMBER_OF_EPOCHS (= 100), CONVERGENCE_THRESHOLD (= 0.99), LEARNING_PARAMETER (= 0.01) and RANDOM_SEED (= 1).
      Parameters:
      aPreprocessedArt2aData - PreprocessedData object created by method Art2aKernel.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 Art2aResult call()
      Performs the clustering process. Note: Parallel Rho winner evaluation is disabled.
      Specified by:
      call in interface Callable<Art2aResult>
      Returns:
      Clustering result or null if clustering process could not be performed.