ij.gui
Class Plot

java.lang.Object
  extended by ij.gui.Plot

public class Plot
extends java.lang.Object

This class is an image that line graphs can be drawn on.


Field Summary
static int BOX
          Display points using an box-shaped mark.
static int CIRCLE
          Display points using a circle 5 pixels in diameter.
static int CROSS
          Display points using an cross-shaped mark.
static int DOT
          Display points using a single pixel.
static int LINE
          Connect points with solid lines.
static int TRIANGLE
          Display points using an tiangular mark.
static int X
          Display points using an X-shaped mark.
 
Constructor Summary
Plot(java.lang.String title, java.lang.String xLabel, java.lang.String yLabel, double[] xValues, double[] yValues)
          This version of the constructor excepts double arrays.
Plot(java.lang.String title, java.lang.String xLabel, java.lang.String yLabel, float[] xValues, float[] yValues)
          Construct a new PlotWindow.
 
Method Summary
 void addErrorBars(double[] errorBars)
          Adds error bars to the plot.
 void addErrorBars(float[] errorBars)
          Adds error bars to the plot.
 void addLabel(double x, double y, java.lang.String label)
          Draws text at the specified location, where (0,0) is the upper left corner of the the plot frame and (1,1) is the lower right corner.
 void addPoints(double[] x, double[] y, int shape)
          Adds a set of points to the plot using double arrays.
 void addPoints(float[] x, float[] y, int shape)
          Adds a set of points to the plot or adds a curve if shape is set to LINE.
 void changeFont(java.awt.Font font)
          Changes the font.
 void draw()
          Draws the plot specified in the constructor.
 ImagePlus getImagePlus()
          Returns the plot as an ImagePlus.
 ImageProcessor getProcessor()
          Returns the plot as an ImageProcessor.
 void setColor(java.awt.Color c)
          Changes the drawing color.
 void setJustification(int justification)
          Sets the justification used by addLabel(), where justification is ImageProcessor.LEFT, ImageProcessor.CENTER or ImageProcessor.RIGHT.
 void setLimits(double xMin, double xMax, double yMin, double yMax)
          Sets the x-axis and y-axis range.
 void setLineWidth(int lineWidth)
          Changes the line width.
 PlotWindow show()
          Displays the plot in a PlotWindow and returns a reference to the PlotWindow.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CIRCLE

public static final int CIRCLE
Display points using a circle 5 pixels in diameter.

See Also:
Constant Field Values

X

public static final int X
Display points using an X-shaped mark.

See Also:
Constant Field Values

BOX

public static final int BOX
Display points using an box-shaped mark.

See Also:
Constant Field Values

TRIANGLE

public static final int TRIANGLE
Display points using an tiangular mark.

See Also:
Constant Field Values

CROSS

public static final int CROSS
Display points using an cross-shaped mark.

See Also:
Constant Field Values

DOT

public static final int DOT
Display points using a single pixel.

See Also:
Constant Field Values

LINE

public static final int LINE
Connect points with solid lines.

See Also:
Constant Field Values
Constructor Detail

Plot

public Plot(java.lang.String title,
            java.lang.String xLabel,
            java.lang.String yLabel,
            float[] xValues,
            float[] yValues)
Construct a new PlotWindow.

Parameters:
title - the window title
xLabel - the x-axis label
yLabel - the y-axis label
xValues - the x-coodinates, or null
yValues - the y-coodinates, or null

Plot

public Plot(java.lang.String title,
            java.lang.String xLabel,
            java.lang.String yLabel,
            double[] xValues,
            double[] yValues)
This version of the constructor excepts double arrays.

Method Detail

setLimits

public void setLimits(double xMin,
                      double xMax,
                      double yMin,
                      double yMax)
Sets the x-axis and y-axis range.


addPoints

public void addPoints(float[] x,
                      float[] y,
                      int shape)
Adds a set of points to the plot or adds a curve if shape is set to LINE.

Parameters:
x - the x-coodinates
y - the y-coodinates
shape - CIRCLE, X, BOX, TRIANGLE, CROSS, DOT or LINE

addPoints

public void addPoints(double[] x,
                      double[] y,
                      int shape)
Adds a set of points to the plot using double arrays. Must be called before the plot is displayed.


addErrorBars

public void addErrorBars(float[] errorBars)
Adds error bars to the plot.


addErrorBars

public void addErrorBars(double[] errorBars)
Adds error bars to the plot.


addLabel

public void addLabel(double x,
                     double y,
                     java.lang.String label)
Draws text at the specified location, where (0,0) is the upper left corner of the the plot frame and (1,1) is the lower right corner.


setJustification

public void setJustification(int justification)
Sets the justification used by addLabel(), where justification is ImageProcessor.LEFT, ImageProcessor.CENTER or ImageProcessor.RIGHT.


setColor

public void setColor(java.awt.Color c)
Changes the drawing color. The frame and labels are always drawn in black.


setLineWidth

public void setLineWidth(int lineWidth)
Changes the line width.


changeFont

public void changeFont(java.awt.Font font)
Changes the font.


draw

public void draw()
Draws the plot specified in the constructor.


getProcessor

public ImageProcessor getProcessor()
Returns the plot as an ImageProcessor.


getImagePlus

public ImagePlus getImagePlus()
Returns the plot as an ImagePlus.


show

public PlotWindow show()
Displays the plot in a PlotWindow and returns a reference to the PlotWindow.