at.mug.iqm.commons.util.plot

Class PlotTools

java.lang.Object

at.mug.iqm.commons.util.plot.PlotTools

public final class PlotTools
extends Object

This class provides helper functions for plot processing.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private static PointFinderPlotFrame	currPeakPlot
private static Vector<Double>	currPlotDataX The current plot data (X-axis).
private static Vector<Double>	currPlotDataY The current plot data (Y-axis).
private static String	currPlotTitle The title for the plot to be displayed.
private static String	currPlotTitleX The title for the X-axis of the plot to be displayed.
private static String	currPlotTitleY The title for the Y-axis of the plot to be displayed.
private static RegressionPlotFrame	currRegPlot The current IqmRegressionPlot.

Constructor Summary

Constructors

Constructor and Description
PlotTools()

Method Summary

Modifier and Type	Method and Description
static org.jfree.data.xy.XYDataset	createHistogramDataset(javax.media.jai.Histogram histo) Creates an XYDataset, consisting of the histogram.
static org.jfree.data.xy.XYDataset	createHistogramDataset(List<PlotModel> plotModels) Creates an XYDataset, consisting of the histogram.
static void	deleteExistingPlot() This method deletes an exisitng plot
static void	displayPlotXY(Vector<Double> dataY, boolean isLineVisible, String plotTitle, String xTitle, String yTitle) This method plots XY Values in an separate window without the x data
static void	displayPlotXY(Vector<Double> dataX, Vector<Double> dataY, boolean isLineVisible, String plotTitle, String xTitle, String yTitle) This method plots XY Values in an separate window
static void	displayPointFinderPlotXY(double[] x, double[] y, double[] x2, double[] y2, boolean isLineVisible, String frameTitle, String plotTitle, String xTitle, String yTitle) 2017-07 This method plots XY Values in a separate window by Adam Dolgos for displaying additional plus signs defined in a second vector
static void	displayPointFinderPlotXY(Vector<Double> dataX, Vector<Double> dataY, Vector<Double> dataX2, Vector<Double> dataY2, boolean isLineVisible, String frameTitle, String plotTitle, String xTitle, String yTitle) 2017-07 This method plots XY Values in a separate window by Adam Dolgos for displaying additional plus signs defined in a second vector
static void	displayRegressionPlotXY(double[] x, double[] y, boolean isLineVisible, String frameTitle, String plotTitle, String xTitle, String yTitle, int regStart, int regEnd, boolean deleteExistingPlot) This method converts double array data to vector data and calls the display routine
static void	displayRegressionPlotXY(Vector<Double> dataX, Vector<Double>[] dataY, boolean isLineVisible, String frameTitle, String plotTitle, String xTitle, String yTitle, int regStart, int regEnd, boolean deleteExistingPlot) This method plots several XY Values in an separate window
static void	displayRegressionPlotXY(Vector<Double> dataX, Vector<Double> dataY, boolean isLineVisible, String frameTitle, String plotTitle, String xTitle, String yTitle, int regStart, int regEnd, boolean deleteExistingPlot) This method plots XY Values in an separate window
private static PointFinderPlotFrame	getCurrPeakFinderPlot()
static Vector<Double>	getCurrPlotDataX() This method gets current plot data
static Vector<Double>	getCurrPlotDataY() This method gets current plot data
static String	getCurrPlotTitle() This method gets current plot data
static String	getCurrPlotTitleX() This method gets current plot data
static String	getCurrPlotTitleY() This method gets current plot data
private static RegressionPlotFrame	getCurrRegPlot()
static javax.media.jai.Histogram	getHistogram(javax.media.jai.PlanarImage pi) This method creates the histogram of a given image and returns the reference to the Histogram object.
static javax.media.jai.Histogram	getHistogram(RenderedImage image) This method creates the histogram of a given image and returns the reference to the Histogram object.
static List<PlotModel>	getIntensityProfile(Raster r, int direction, int index) Extracts the intensity profile of a given row or column index.
static double[]	getLinearRegression(Vector<Double> dataX, Vector<Double> dataY, int regStart, int regEnd) this method calculates the linear Regression parameters Y = p[0] + p[1].X
static double[]	getMaxLikeliHoodEstimate(Vector<Double> dataX, Vector<Double> dataY, int regStart, int regEnd) This method calculates the Maximum Likelihood Estimation instead of a linear regression.
static void	projectImage(javax.media.jai.PlanarImage pi, int direction) Project a given image to a selected direction of the Cartesian coordinate system.
private static void	setCurrPeakFinderPlot(PointFinderPlotFrame pl)
static void	setCurrPlotXYData(Vector<Double> dataX, Vector<Double> dataY, String plotTitle, String titleX, String titleY) This method sets the current plot data
private static void	setCurrRegPlot(RegressionPlotFrame pl)
static javax.media.jai.Histogram	showHistogram(javax.media.jai.PlanarImage pi) This method plots the histogram in a new HistogramPlotFrame and returns the reference to the Histogram object.
static javax.media.jai.PlanarImage	toPlanarImage(List<PlotModel> plotModels) This method creates a PlanarImage from a List of PlotModels.
static javax.media.jai.PlanarImage	toPlanarImage(PlotModel plotModel, boolean showAxes) This method creates a PlanarImage from a single PlotModel .
static List<PlotModel>	toPlotModel(org.jfree.data.xy.XYDataset dataSet) Creates a list of PlotModels out of an XYDataset.
static List<PlotModel>	toPlotModels(DefaultTableModel tableModel, int direction) Creates a list of PlotModels out of a DefaultTableModel.

Methods inherited from class java.lang.Object

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

Field Detail

currPeakPlot

private static PointFinderPlotFrame currPeakPlot

currRegPlot

private static RegressionPlotFrame currRegPlot

The current IqmRegressionPlot. Default is 'null'.

currPlotDataX

private static Vector<Double> currPlotDataX

The current plot data (X-axis). Default is 'null'.

currPlotDataY

private static Vector<Double> currPlotDataY

The current plot data (Y-axis). Default is 'null'.

currPlotTitle

private static String currPlotTitle

The title for the plot to be displayed. Default is 'null'.

currPlotTitleX

private static String currPlotTitleX

The title for the X-axis of the plot to be displayed. Default is 'null'.

currPlotTitleY

private static String currPlotTitleY

The title for the Y-axis of the plot to be displayed. Default is 'null'.

Constructor Detail

PlotTools

public PlotTools()

Method Detail

deleteExistingPlot

public static void deleteExistingPlot()

This method deletes an exisitng plot

displayRegressionPlotXY

public static void displayRegressionPlotXY(double[] x,
                                           double[] y,
                                           boolean isLineVisible,
                                           String frameTitle,
                                           String plotTitle,
                                           String xTitle,
                                           String yTitle,
                                           int regStart,
                                           int regEnd,
                                           boolean deleteExistingPlot)

This method converts double array data to vector data and calls the display routine

displayRegressionPlotXY

public static void displayRegressionPlotXY(Vector<Double> dataX,
                                           Vector<Double> dataY,
                                           boolean isLineVisible,
                                           String frameTitle,
                                           String plotTitle,
                                           String xTitle,
                                           String yTitle,
                                           int regStart,
                                           int regEnd,
                                           boolean deleteExistingPlot)

This method plots XY Values in an separate window

displayPointFinderPlotXY

public static void displayPointFinderPlotXY(Vector<Double> dataX,
                                            Vector<Double> dataY,
                                            Vector<Double> dataX2,
                                            Vector<Double> dataY2,
                                            boolean isLineVisible,
                                            String frameTitle,
                                            String plotTitle,
                                            String xTitle,
                                            String yTitle)

2017-07 This method plots XY Values in a separate window by Adam Dolgos for displaying additional plus signs defined in a second vector

displayPointFinderPlotXY

public static void displayPointFinderPlotXY(double[] x,
                                            double[] y,
                                            double[] x2,
                                            double[] y2,
                                            boolean isLineVisible,
                                            String frameTitle,
                                            String plotTitle,
                                            String xTitle,
                                            String yTitle)

2017-07 This method plots XY Values in a separate window by Adam Dolgos for displaying additional plus signs defined in a second vector

displayRegressionPlotXY

public static void displayRegressionPlotXY(Vector<Double> dataX,
                                           Vector<Double>[] dataY,
                                           boolean isLineVisible,
                                           String frameTitle,
                                           String plotTitle,
                                           String xTitle,
                                           String yTitle,
                                           int regStart,
                                           int regEnd,
                                           boolean deleteExistingPlot)

This method plots several XY Values in an separate window

getLinearRegression

public static double[] getLinearRegression(Vector<Double> dataX,
                                           Vector<Double> dataY,
                                           int regStart,
                                           int regEnd)

this method calculates the linear Regression parameters Y = p[0] + p[1].X

getMaxLikeliHoodEstimate

public static double[] getMaxLikeliHoodEstimate(Vector<Double> dataX,
                                                Vector<Double> dataY,
                                                int regStart,
                                                int regEnd)

This method calculates the Maximum Likelihood Estimation instead of a linear regression. according to Clauset A., Shalizi C.R., Newman M.E.J., Power-Law Distributions in Empirical Data, SIAM Review, 2009 does not work properly until now!!!!!!!!!!

displayPlotXY

public static void displayPlotXY(Vector<Double> dataY,
                                 boolean isLineVisible,
                                 String plotTitle,
                                 String xTitle,
                                 String yTitle)

This method plots XY Values in an separate window without the x data

displayPlotXY

public static void displayPlotXY(Vector<Double> dataX,
                                 Vector<Double> dataY,
                                 boolean isLineVisible,
                                 String plotTitle,
                                 String xTitle,
                                 String yTitle)

This method plots XY Values in an separate window

setCurrPlotXYData

public static void setCurrPlotXYData(Vector<Double> dataX,
                                     Vector<Double> dataY,
                                     String plotTitle,
                                     String titleX,
                                     String titleY)

This method sets the current plot data

Parameters:

dataX -

dataY -

plotTitle -

titleX -

titleY -

getCurrPlotDataX

public static Vector<Double> getCurrPlotDataX()

This method gets current plot data

Returns:

Vector

getCurrPlotDataY

public static Vector<Double> getCurrPlotDataY()

This method gets current plot data

Returns:

Vector

getCurrPlotTitle

public static String getCurrPlotTitle()

This method gets current plot data

Returns:

String

getCurrPlotTitleX

public static String getCurrPlotTitleX()

This method gets current plot data

Returns:

String

getCurrPlotTitleY

public static String getCurrPlotTitleY()

This method gets current plot data

Returns:

String

showHistogram

public static javax.media.jai.Histogram showHistogram(javax.media.jai.PlanarImage pi)

This method plots the histogram in a new HistogramPlotFrame and returns the reference to the Histogram object.

Parameters:

pi - the image to create the histogram from

Returns:

a reference to the histogram

createHistogramDataset

public static org.jfree.data.xy.XYDataset createHistogramDataset(javax.media.jai.Histogram histo)

Creates an XYDataset, consisting of the histogram.

Returns:

The data set.

createHistogramDataset

public static org.jfree.data.xy.XYDataset createHistogramDataset(List<PlotModel> plotModels)

Creates an XYDataset, consisting of the histogram.

Returns:

The data set.

getHistogram

public static javax.media.jai.Histogram getHistogram(RenderedImage image)

This method creates the histogram of a given image and returns the reference to the Histogram object.

Parameters:

image - the image to create the histogram from

Returns:

a Histogram

See Also:

getHistogram(PlanarImage)

getHistogram

public static javax.media.jai.Histogram getHistogram(javax.media.jai.PlanarImage pi)

This method creates the histogram of a given image and returns the reference to the Histogram object.

Parameters:

pi - the image to create the histogram from

Returns:

a Histogram

setCurrRegPlot

private static void setCurrRegPlot(RegressionPlotFrame pl)

getCurrRegPlot

private static RegressionPlotFrame getCurrRegPlot()

setCurrPeakFinderPlot

private static void setCurrPeakFinderPlot(PointFinderPlotFrame pl)

getCurrPeakFinderPlot

private static PointFinderPlotFrame getCurrPeakFinderPlot()

toPlanarImage

public static javax.media.jai.PlanarImage toPlanarImage(List<PlotModel> plotModels)
                                                 throws Exception

This method creates a PlanarImage from a List of PlotModels. This list of PlotModels are separate data series in a JFreeChart.

The standard dimension for the generated image are 150x100 px.

Parameters:

plotModels - the list of 1...n plot models

Returns:

an image of the data rows (plot models), or null if the parameter is null, or the list is empty

Throws:

Exception - if any error occurs in the conversion

toPlanarImage

public static javax.media.jai.PlanarImage toPlanarImage(PlotModel plotModel,
                                                        boolean showAxes)
                                                 throws Exception

This method creates a PlanarImage from a single PlotModel .

The standard dimension for the generated image are 150x100 px.

Parameters:

plotModel - the single PlotModel

showAxes - a flag whether or not the axes should be displayed in the image of the plot model

Returns:

an image of the plot model, or null if the parameter is null

Throws:

Exception - if any error occurs in the conversion

projectImage

public static void projectImage(javax.media.jai.PlanarImage pi,
                                int direction)

Project a given image to a selected direction of the Cartesian coordinate system.

Parameters:

pi -

direction - must not be null, must, either be 0 (x-axis) or 1 (y-axis), see also IQMConstants

toPlotModel

public static List<PlotModel> toPlotModel(org.jfree.data.xy.XYDataset dataSet)

Creates a list of PlotModels out of an XYDataset.

The series count of the XYDataSet determines the number of list elements, such as the list may just contain a single element.

Parameters:

dataSet - the data set

Returns:

a List of PlotModels of the data set that is displayable in the IPlotPanel

Throws:

IllegalArgumentException - if the data set is null or does not contain any data series

toPlotModels

public static List<PlotModel> toPlotModels(DefaultTableModel tableModel,
                                           int direction)

Creates a list of PlotModels out of a DefaultTableModel.

Parameters:

tableModel - the DefaultTableModel

direction - an integer indicating whether the rows (vertical) or columns (horizontal) contain the values of a single signal, see also IQMConstants

Returns:

a plot model of the data set that is displayable in the IPlotPanel

Throws:

IllegalArgumentException - if the table model is null or does not contain any elements

getIntensityProfile

public static List<PlotModel> getIntensityProfile(Raster r,
                                                  int direction,
                                                  int index)

Extracts the intensity profile of a given row or column index.

Parameters:

r -

direction -

index -

Returns:

the list of plot models (one for each color band)