weka.core

Class ChartUtils

java.lang.Object

weka.core.ChartUtils

public class ChartUtils
extends java.lang.Object

Utility routines for plotting various charts using the JFreeChart library.

Version:

$Revision: 13242 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Constructor Summary

Constructors

Constructor and Description
ChartUtils()

Method Summary

Modifier and Type	Method and Description
static java.awt.image.BufferedImage	createAttributeChartNominal(weka.core.Attribute summaryAtt, java.lang.String attName, java.io.OutputStream dos, int width, int height) Creates and writes a combined chart for a nominal attribute given its summary attribute information and an output stream to write to
static java.awt.image.BufferedImage	createAttributeChartNumeric(NumericAttributeBinData binStats, weka.core.Attribute summaryAtt, java.io.OutputStream dos, int width, int height)
static java.awt.Image	getHeatMapForMatrix(weka.core.matrix.Matrix matrix, java.util.List<java.lang.String> rowAttNames) Generates a heat map from a matrix of correlations
static void	main(java.lang.String[] args)
static java.awt.image.BufferedImage	renderBoxPlotFromSummaryData(int width, int height, java.util.List<java.lang.Double> summary, java.util.List<java.lang.Double> outliers, java.util.List<java.lang.String> additionalArgs) Create a box plot buffered image from summary data (mean, median, q1, q3, min, max, minOutlier, maxOutlier, list of outliers)
static java.awt.image.BufferedImage	renderCombinedBoxPlotAndHistogramFromSummaryData(int width, int height, java.util.List<java.lang.String> bins, java.util.List<java.lang.Double> freqs, java.util.List<java.lang.Double> summary, java.util.List<java.lang.Double> outliers, java.util.List<java.lang.String> additionalArgs) Render a combined histogram and box plot chart from summary data
static java.awt.image.BufferedImage	renderCombinedPieAndHistogramFromSummaryData(int width, int height, java.util.List<java.lang.String> values, java.util.List<java.lang.Double> freqs, java.util.List<java.lang.String> additionalArgs) Render a combined histogram and pie chart from summary data
static java.awt.image.BufferedImage	renderHistogramFromSummaryData(int width, int height, java.util.List<java.lang.String> bins, java.util.List<java.lang.Double> freqs, java.util.List<java.lang.String> additionalArgs) Render a histogram chart from summary data (i.e.
static java.awt.image.BufferedImage	renderPieChartFromSummaryData(int width, int height, java.util.List<java.lang.String> values, java.util.List<java.lang.Double> freqs, boolean showLabels, boolean showLegend, java.util.List<java.lang.String> additionalArgs) Render a pie chart from summary data (i.e.
static void	writeImage(java.awt.image.BufferedImage image, java.io.OutputStream dest) Write a BufferedImage to a destination output stream as a png

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartUtils

public ChartUtils()

Method Detail

getHeatMapForMatrix

public static java.awt.Image getHeatMapForMatrix(weka.core.matrix.Matrix matrix,
                                                 java.util.List<java.lang.String> rowAttNames)

Generates a heat map from a matrix of correlations

Parameters:

matrix - a Matrix (expected to hold correlation values between -1 and 1)

rowAttNames - a list of labels for the columns/rows

Returns:

an Image holding the heat map

writeImage

public static void writeImage(java.awt.image.BufferedImage image,
                              java.io.OutputStream dest)
                       throws java.io.IOException

Write a BufferedImage to a destination output stream as a png

Parameters:

image - the image to write

dest - the destination output stream

Throws:

java.io.IOException - if a problem occurs

renderHistogramFromSummaryData

public static java.awt.image.BufferedImage renderHistogramFromSummaryData(int width,
                                                                          int height,
                                                                          java.util.List<java.lang.String> bins,
                                                                          java.util.List<java.lang.Double> freqs,
                                                                          java.util.List<java.lang.String> additionalArgs)
                                                                   throws java.lang.Exception

Render a histogram chart from summary data (i.e. a list of bin labels and corresponding frequencies) to a buffered image

Parameters:

width - the width of the resulting image

height - the height of the resulting image

bins - the list of bin labels

freqs - the corresponding bin frequencies

additionalArgs - optional arguments to the renderer (may be null)

Returns:

a histogram as a buffered image

Throws:

java.lang.Exception - if a problem occurs

renderBoxPlotFromSummaryData

public static java.awt.image.BufferedImage renderBoxPlotFromSummaryData(int width,
                                                                        int height,
                                                                        java.util.List<java.lang.Double> summary,
                                                                        java.util.List<java.lang.Double> outliers,
                                                                        java.util.List<java.lang.String> additionalArgs)
                                                                 throws java.lang.Exception

Create a box plot buffered image from summary data (mean, median, q1, q3, min, max, minOutlier, maxOutlier, list of outliers)

Parameters:

width - the width of the resulting image

height - the height of the resulting image

summary - summary data

outliers - list of outlier values

additionalArgs - additional options to the renderer

Returns:

a box plot chart

Throws:

java.lang.Exception - if a problem occurs

renderPieChartFromSummaryData

public static java.awt.image.BufferedImage renderPieChartFromSummaryData(int width,
                                                                         int height,
                                                                         java.util.List<java.lang.String> values,
                                                                         java.util.List<java.lang.Double> freqs,
                                                                         boolean showLabels,
                                                                         boolean showLegend,
                                                                         java.util.List<java.lang.String> additionalArgs)
                                                                  throws java.lang.Exception

Render a pie chart from summary data (i.e. a list of values and their corresponding frequencies) to a buffered image

Parameters:

width - the width of the resulting image

height - the height of the resulting image

values - a list of values for the chart

freqs - a list of corresponding frequencies

showLabels - true if the chart will show labels

showLegend - true if the chart will show a legend

additionalArgs - optional arguments to the renderer (may be null)

Returns:

a buffered image

Throws:

java.lang.Exception - if a problem occurs

renderCombinedPieAndHistogramFromSummaryData

public static java.awt.image.BufferedImage renderCombinedPieAndHistogramFromSummaryData(int width,
                                                                                        int height,
                                                                                        java.util.List<java.lang.String> values,
                                                                                        java.util.List<java.lang.Double> freqs,
                                                                                        java.util.List<java.lang.String> additionalArgs)
                                                                                 throws java.lang.Exception

Render a combined histogram and pie chart from summary data

Parameters:

width - the width of the resulting image

height - the height of the resulting image

values - the values for the chart

freqs - the corresponding frequencies

additionalArgs - optional arguments to the renderer (may be null)

Returns:

a buffered image

Throws:

java.lang.Exception - if a problem occurs

renderCombinedBoxPlotAndHistogramFromSummaryData

public static java.awt.image.BufferedImage renderCombinedBoxPlotAndHistogramFromSummaryData(int width,
                                                                                            int height,
                                                                                            java.util.List<java.lang.String> bins,
                                                                                            java.util.List<java.lang.Double> freqs,
                                                                                            java.util.List<java.lang.Double> summary,
                                                                                            java.util.List<java.lang.Double> outliers,
                                                                                            java.util.List<java.lang.String> additionalArgs)
                                                                                     throws java.lang.Exception

Render a combined histogram and box plot chart from summary data

Parameters:

width - the width of the resulting image

height - the height of the resulting image

bins - the values for the chart

freqs - the corresponding frequencies

summary - the summary stats for the box plot

outliers - an optional list of outliers for the box plot

additionalArgs - optional arguments to the renderer (may be null)

Returns:

a buffered image

Throws:

java.lang.Exception - if a problem occurs

createAttributeChartNumeric

public static java.awt.image.BufferedImage createAttributeChartNumeric(NumericAttributeBinData binStats,
                                                                       weka.core.Attribute summaryAtt,
                                                                       java.io.OutputStream dos,
                                                                       int width,
                                                                       int height)
                                                                throws java.io.IOException

Throws:

java.io.IOException

createAttributeChartNominal

public static java.awt.image.BufferedImage createAttributeChartNominal(weka.core.Attribute summaryAtt,
                                                                       java.lang.String attName,
                                                                       java.io.OutputStream dos,
                                                                       int width,
                                                                       int height)
                                                                throws java.io.IOException

Creates and writes a combined chart for a nominal attribute given its summary attribute information and an output stream to write to

Parameters:

summaryAtt - the summary attribute for the attribute to process

attName - the name of the attribute

dos - the output stream to write to (can be null for no write)

width - the width of the chart

height - the height of the chart

Returns:

a BufferedImage containing the chart

Throws:

java.io.IOException - if a problem occurs

main

public static void main(java.lang.String[] args)