org.matsim.contrib.socnetgen.sna.graph.analysis.TransitivityTask.java Source code

Introduction

Here is the source code for org.matsim.contrib.socnetgen.sna.graph.analysis.TransitivityTask.java

Source

/* *********************************************************************** *
 * project: org.matsim.*
 * TransitivityTask.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2010 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   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.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */
package org.matsim.contrib.socnetgen.sna.graph.analysis;

import org.apache.commons.math.stat.descriptive.DescriptiveStatistics;
import org.apache.log4j.Logger;
import org.matsim.contrib.common.stats.LinearDiscretizer;
import org.matsim.contrib.socnetgen.sna.graph.Graph;

import java.io.IOException;
import java.util.Map;

/**
 * An AnalyzerTask that calculated transitivity related measurements.
 * 
 * @author illenberger
 * 
 */
public class TransitivityTask extends ModuleAnalyzerTask<Transitivity> {

    public static final Logger logger = Logger.getLogger(TransitivityTask.class);

    public static final String KEY = "c";

    public static final String MEAN_LOCAL_CLUSTERING = "c_local_mean";

    public static final String MIN_LOCAL_CLUSTERING = "c_local_min";

    public static final String MAX_LOCAL_CLUSTERING = "c_local_max";

    public static final String GLOBAL_CLUSTERING_COEFFICIENT = "c_global";

    /**
     * Creates a new TransitivityTask with an instance of {@link Transitivity}
     * used for analysis.
     */
    public TransitivityTask() {
        setKey(KEY);
        setModule(Transitivity.getInstance());
    }

    /**
     * Calculates the mean local clustering coefficient, the maximum local
     * clustering coefficient, the minimum local clustering coefficient and the
     * global clustering coefficient. Writes the histogram of the local
     * clustering coefficient distribution into the output directory (if
     * specified).
     * 
     * @param graph
     *            a graph.
     * @param stats
     *            a map where the results of the analysis are stored.
     */
    //   @Override
    //   public void analyze(Graph graph, Map<String, Double> stats) {
    //      DescriptiveStatistics distr = module.localClusteringDistribution(graph.getVertices());
    //      double c_mean = distr.getMean();
    //      double c_max = distr.getMax();
    //      double c_min = distr.getMin();
    //      stats.put(MEAN_LOCAL_CLUSTERING, c_mean);
    //      stats.put(MAX_LOCAL_CLUSTERING, c_max);
    //      stats.put(MIN_LOCAL_CLUSTERING, c_min);
    //
    //      double c_global = module.globalClusteringCoefficient(graph);
    //      stats.put(GLOBAL_CLUSTERING_COEFFICIENT, c_global);
    //
    //      logger.info(String.format(
    //            "c_local_mean = %1$.4f, c_local_max = %2$.4f, c_local_min = %3$.4f, c_global = %4$.4f.", c_mean, c_max,
    //            c_min, c_global));
    //
    //      if (getOutputDirectory() != null) {
    //         try {
    //            writeHistograms(distr, new LinearDiscretizer(0.05), "c_local", false);
    //         } catch (FileNotFoundException e) {
    //            e.printStackTrace();
    //         } catch (IOException e) {
    //            e.printStackTrace();
    //         }
    //      }
    //   }

    public void analyze(Graph graph, Map<String, DescriptiveStatistics> statsMap) {
        String subKey = key + "_local";

        DescriptiveStatistics stats = module.statistics(graph.getVertices());
        printStats(stats, subKey);
        statsMap.put(subKey, stats);

        if (outputDirectoryNotNull()) {
            try {
                writeHistograms(stats, new LinearDiscretizer(0.05), subKey, false);
                writeHistograms(stats, subKey, 100, 20);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        subKey = key + "_global";
        stats = new DescriptiveStatistics();
        stats.addValue(module.globalClusteringCoefficient(graph));
        printStats(stats, subKey);
        statsMap.put(subKey, stats);
    }
}