opendial.gui.utils.DistributionViewer.java Source code

Java tutorial

Introduction

Here is the source code for opendial.gui.utils.DistributionViewer.java

Source

// =================================================================                                                                   
// Copyright (C) 2011-2015 Pierre Lison (plison@ifi.uio.no)

// Permission is hereby granted, free of charge, to any person 
// obtaining a copy of this software and associated documentation 
// files (the "Software"), to deal in the Software without restriction, 
// including without limitation the rights to use, copy, modify, merge, 
// publish, distribute, sublicense, and/or sell copies of the Software, 
// and to permit persons to whom the Software is furnished to do so, 
// subject to the following conditions:

// The above copyright notice and this permission notice shall be 
// included in all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// =================================================================                                                                   

package opendial.gui.utils;

import java.util.logging.*;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Container;
import java.awt.Dialog;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;
import java.util.Set;
import java.util.function.Consumer;

import javax.swing.JDialog;
import javax.swing.JLabel;

import opendial.DialogueState;
import opendial.bn.distribs.CategoricalTable;
import opendial.bn.distribs.ContinuousDistribution;
import opendial.bn.distribs.IndependentDistribution;
import opendial.bn.distribs.densityfunctions.DensityFunction;
import opendial.bn.distribs.densityfunctions.DirichletDensityFunction;
import opendial.bn.distribs.densityfunctions.KernelDensityFunction;

import org.jfree.chart.ChartFactory;
import org.jfree.chart.ChartPanel;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.CombinedDomainXYPlot;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.category.BarRenderer;
import org.jfree.chart.renderer.category.StandardBarPainter;
import org.jfree.data.category.DefaultCategoryDataset;
import org.jfree.data.xy.XYSeries;
import org.jfree.data.xy.XYSeriesCollection;

/**
 * GUI window displaying a (discrete or continuous) distribution as a chart. The
 * graphical layout of the chart is based on JFreeChart.
 * 
 * @author Pierre Lison (plison@ifi.uio.no)
 */
@SuppressWarnings({ "deprecation", "serial" })
public class DistributionViewer extends JDialog {

    // logger
    final static Logger log = Logger.getLogger("OpenDial");

    String queryVar;
    IndependentDistribution lastDistrib;

    /**
     * Constructs a new viewer for the given distribution, connected to the state
     * viewer component.
     * 
     * @param currentState the current dialogue state
     * @param queryVar the variable to display
     * @param viewer the state viewer component
     */
    public DistributionViewer(final DialogueState currentState, final String queryVar, final StateViewer viewer) {
        super(viewer.tab.getMainFrame().getFrame(), Dialog.ModalityType.MODELESS);
        setTitle("Distribution Viewer");
        this.queryVar = queryVar;
        update(currentState);

        addWindowListener(new WindowAdapter() {
            @Override
            public void windowClosing(WindowEvent e) {
                super.windowClosing(e);
                viewer.shownDistribs.remove(queryVar);
            }

        });
    }

    /**
     * Constructs or update the current viewer with the distribution.
     * 
     * @param currentState the updated dialogue state
     */
    protected void update(DialogueState currentState) {

        if (!currentState.hasChanceNode(queryVar)) {
            return;
        } else if (lastDistrib != null
                && this.lastDistrib.equals(currentState.getChanceNode(queryVar).getDistrib())) {
            return;
        }
        this.lastDistrib = currentState.queryProb(queryVar);

        Container container = new Container();
        container.setLayout(new BorderLayout());
        container.add(new JLabel("        "), BorderLayout.NORTH);
        container.add(new JLabel("        "), BorderLayout.WEST);
        container.add(new JLabel("        "), BorderLayout.EAST);
        container.add(new JLabel("        "), BorderLayout.SOUTH);

        try {
            IndependentDistribution indepDistrib = currentState.queryProb(queryVar);
            if (indepDistrib instanceof ContinuousDistribution) {
                container.add(generatePanel(indepDistrib.toContinuous()), BorderLayout.CENTER);
            } else {
                container.add(generatePanel(indepDistrib.toDiscrete()), BorderLayout.CENTER);
            }
        } catch (RuntimeException e) {
            log.warning("could not generate distribution viewer: " + e);
        }
        setContentPane(container);
        if (getSize().height == 0 || getSize().width == 0) {
            pack();
            setLocation(new Random().nextInt(500), (new Random()).nextInt(500));
            setVisible(true);
        } else {
            validate();
        }
    }

    /**
     * Generates a chart panel for the categorical table.
     * 
     * @param distrib the categorical table
     * @return the constructed chart panel
     */
    private ChartPanel generatePanel(CategoricalTable distrib) {
        final String variableName = distrib.getVariable();

        DefaultCategoryDataset dataset = new DefaultCategoryDataset();

        distrib.getValues().stream().forEach(d -> dataset.addValue(distrib.getProb(d), "", "" + d));

        JFreeChart chart = ChartFactory.createBarChart("Probability distribution P(" + variableName + ")", // chart
                // title
                "Value", // domain axis label
                "Probability", // range axis label
                dataset, // data
                PlotOrientation.VERTICAL, // orientation
                false, // include legend
                true, // tooltips
                false); // URLs

        CategoryPlot plot = (CategoryPlot) chart.getPlot();
        BarRenderer renderer = (BarRenderer) plot.getRenderer();
        renderer.setToolTipGenerator((d, s, c) -> {
            return "P(" + variableName + "=" + d.getColumnKeys().get(c) + ") = " + d.getValue(s, c);
        });

        renderer.setBarPainter(new StandardBarPainter());
        renderer.setDrawBarOutline(false);
        renderer.setSeriesPaint(0, new Color(5, 100, 30));

        return new ChartPanel(chart, true, true, true, true, true);

    }

    /**
     * Constructs a chart panel for the continuous distribution.
     * 
     * @param distrib the continuous distribution
     * @return the generated chart panel
     */
    private ChartPanel generatePanel(ContinuousDistribution distrib) {

        final String variableName = distrib.getVariable();

        List<XYSeries> series = extractSeries(distrib.getFunction());

        CombinedDomainXYPlot combined = new CombinedDomainXYPlot(new NumberAxis("Value"));
        for (XYSeries serie : series) {

            JFreeChart chart = ChartFactory.createXYLineChart("", // chart title
                    "Value", // domain axis label
                    "Density", // range axis label
                    new XYSeriesCollection(serie), // data
                    PlotOrientation.VERTICAL, // orientation
                    (distrib.getFunction().getDimensions() > 1), // include
                    // legend
                    true, // tooltips?
                    false); // URLs?

            XYPlot plot = (XYPlot) chart.getPlot();
            combined.add(plot);
            plot.setBackgroundPaint(Color.white);
            plot.setRangeGridlinePaint(Color.white);
        }

        return new ChartPanel(new JFreeChart("Probability distribution P(" + variableName + ")",
                JFreeChart.DEFAULT_TITLE_FONT, combined, true), false);
    }

    private List<XYSeries> extractSeries(DensityFunction function) {

        List<XYSeries> series = new ArrayList<XYSeries>();

        for (int i = 0; i < function.getDimensions(); i++) {
            series.add(new XYSeries("dimension " + i));
        }

        Consumer<double[]> addToSeries = p -> {
            double density = function.getDensity(p);
            for (int d = 0; d < p.length; d++) {
                series.get(d).add(p[d], density);
            }
        };

        Set<double[]> points = function.discretise(500).keySet();
        points.stream().forEach(addToSeries);

        for (XYSeries serie : series) {
            boolean doSmoothing = (function instanceof KernelDensityFunction)
                    || (function instanceof DirichletDensityFunction);
            while (doSmoothing) {
                int nbFluctuations = 0;
                double prevPrevY = serie.getY(0).doubleValue();
                double prevY = serie.getY(1).doubleValue();
                for (int i = 2; i < serie.getItemCount(); i++) {
                    double currentY = serie.getY(i).doubleValue();
                    if (Math.signum(prevY - prevPrevY) != Math.signum(currentY - prevY)) {
                        double avg = (prevPrevY + prevY + currentY) / 3.0;
                        serie.updateByIndex(i - 2, avg);
                        serie.updateByIndex(i - 1, avg);
                        serie.updateByIndex(i, avg);
                        nbFluctuations++;
                    }
                    prevPrevY = prevY;
                    prevY = currentY;
                }
                doSmoothing = (nbFluctuations > points.size() / 2) ? true : false;
            }

        }
        return series;
    }

}