clusteringhierarchicalbuild.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

 /**
  * Title: XELOPES Data Mining Library
  * Description: The XELOPES library is an open platform-independent and data-source-independent library for Embedded Data Mining.
  * Copyright: Copyright (c) 2002 Prudential Systems Software GmbH
  * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
  * @author Carsten Weisse
  * @author Michael Thess
  * @version 1.0
  */

package com.prudsys.pdm.Examples;

import com.prudsys.pdm.Core.MiningAlgorithm;
import com.prudsys.pdm.Core.MiningAlgorithmSpecification;
import com.prudsys.pdm.Core.MiningDataSpecification;
import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Input.MiningInputStream;
import com.prudsys.pdm.Input.Records.Arff.MiningArffStream;
import com.prudsys.pdm.Models.Clustering.Cluster;
import com.prudsys.pdm.Models.Clustering.Hierarchical.ClusterDistance;
import com.prudsys.pdm.Models.Clustering.Hierarchical.HierarchicalClusteringAlgorithm;
import com.prudsys.pdm.Models.Clustering.Hierarchical.HierarchicalClusteringMiningModel;
import com.prudsys.pdm.Models.Clustering.Hierarchical.HierarchicalClusteringSettings;
import com.prudsys.pdm.Utils.GeneralUtils;

/**
 * Builds a hierarchical clustering model.
 */
public class ClusteringHierarchicalBuild extends BasisExample {

  /**
   * Empty constructor.
   */
  public ClusteringHierarchicalBuild() {
  }

  /**
   * Run the example of this class.
   *
   * @throws Exception error while example is running
   */
  public void runExample() throws Exception {

    // Open data source and get metadata:
    MiningInputStream inputData = new MiningArffStream( "data/arff/iris.arff" );
    MiningDataSpecification metaData = inputData.getMetaData();

    // Create MiningSettings object and assign metadata:
    HierarchicalClusteringSettings miningSettings = new HierarchicalClusteringSettings();
    miningSettings.setDataSpecification( metaData );

    // Assign settings:
    ClusterDistance clustDist = new ClusterDistance();
    clustDist.setType( ClusterDistance.TYPE_EUCLIDEAN );
    clustDist.setCompareFunction( ClusterDistance.COMPARISON_FUNCTION_ABS_DIFF );
    clustDist.setMeasureType( ClusterDistance.MEASURE_TYPE_DISTANCE );
    clustDist.setNormalized( false );
    clustDist.setClustDistType( ClusterDistance.CDTYPE_COMPLETE_LINKAGE );
    miningSettings.setDistance( clustDist );
    miningSettings.verifySettings();

    // Get default mining algorithm specification from 'algorithms.xml':
    MiningAlgorithmSpecification miningAlgorithmSpecification =
      MiningAlgorithmSpecification.getMiningAlgorithmSpecification( "HierarchicalAgglomerative", null );
    if( miningAlgorithmSpecification == null )
      throw new MiningException( "Can't find hierarchical agglomerative clustering method." );

    // Get class name from algorithms specification:
    String className = miningAlgorithmSpecification.getClassname();
    if( className == null )
      throw new MiningException( "classname attribute expected." );

    // Set and display mining parameters:
    GeneralUtils.displayMiningAlgSpecParameters(miningAlgorithmSpecification);

    // Create algorithm object with default values:
    MiningAlgorithm algorithm = (HierarchicalClusteringAlgorithm)
        GeneralUtils.createMiningAlgorithmInstance(className);

    // Put it all together:
    algorithm.setMiningInputStream( inputData );
    algorithm.setMiningSettings( miningSettings );
    algorithm.setMiningAlgorithmSpecification( miningAlgorithmSpecification );
    algorithm.verify();

    // Build the mining model:
    MiningModel model = algorithm.buildModel();
    System.out.println("calculation time [s]: " + algorithm.getTimeSpentToBuildModel());

    // Show the clusters:
    showClusters( (HierarchicalClusteringMiningModel) model );
  }

  /**
   * Example of building a hierarchical cluster model.
   *
   * @param args arguments (ignored)
   */
  public static void main(String[] args) {

    try {
      new ClusteringHierarchicalBuild().runExample();
    }
    catch (Exception ex) {
      ex.printStackTrace();
    }
  }

  /**
   * Shows clusters.
   *
   * @param clustModel clustering model to show
   * @throws MiningException cannot show clusters
   */
   public static void showClusters(HierarchicalClusteringMiningModel clustModel)
      throws MiningException {

      System.out.println("number of clusters: " + clustModel.getNumberOfClusters());
      Cluster[] clust = clustModel.getClusters();
      for (int i = 0; i < clust.length; i++)
        System.out.println("Clust["+i+"]: " + clust[i].toString() );

      clustModel.getClustersByThreshold(1.0);
   }
}