org.opensourcephysics.display2d
Class GridPlot

java.lang.Object
  org.opensourcephysics.display.MeasuredImage
      org.opensourcephysics.display2d.GridPlot

All Implemented Interfaces:

Drawable, Measurable, Plot2D

public class GridPlot
extends MeasuredImage
implements Plot2D

GridPlot plots a scalar field by coloring pixels using a buffered image. The buffered image is scaled before it is copied to a drawing panel.

Version:

1.0

Author:

Wolfgang Christian

Field Summary

Fields inherited from class org.opensourcephysics.display.MeasuredImage

image, visible, xmax, xmin, ymax, ymin

Fields inherited from interface org.opensourcephysics.display2d.Plot2D

CONTOUR_PLOT, GRID_PLOT, INTERPOLATED_PLOT, SURFACE_PLOT

Constructor Summary

GridPlot()
Constructs a GridPlot without any data.

GridPlot(GridData griddata)
Constructs the GridPlot using the given griddata.

Method Summary

void	draw(DrawingPanel panel, java.awt.Graphics g) Draws the image and the grid.
double	getCeiling() Gets the ceiling for scaling the z data.
double	getFloor() Gets the floor for scaling the z data.
GridData	getGridData() Gets the GridData object.
static XML.ObjectLoader	getLoader() Gets an XML.ObjectLoader to save and load data for this program.
double	indexToX(int i) Gets the x coordinate for the given index.
double	indexToY(int i) Gets the y coordinate for the given index.
boolean	isAutoscaleZ() Gets the autoscale flag for z.
protected void	recolorImage() Recolors the image pixels using the data array.
void	setAll(java.lang.Object obj) Sets the data to new values.
void	setAll(java.lang.Object obj, double xmin, double xmax, double ymin, double ymax) Sets the values and the scale.
void	setAutoscaleZ(boolean isAutoscale, double floor, double ceil) Sets the autoscale flag and the floor and ceiling values for the colors.
void	setColorPalette(java.awt.Color[] colors) Sets the colors that will be used between the floor and ceiling values.
void	setExpandedZ(boolean expanded, double expansionFactor) Expands the z scale so as to enhance values close to zero.
void	setFloorCeilColor(java.awt.Color floorColor, java.awt.Color ceilColor) Sets the floor and ceiling colors.
void	setGridData(GridData _griddata) Sets the data storage to the given value.
void	setGridLineColor(java.awt.Color c) Sets the color for grid line boundaries
void	setIndexes(int[] indexes) Sets the indexes for the data component that will be plotted.
void	setPaletteType(int type) Determines the palette type that will be used.
void	setShowGridLines(boolean showGrid) Outlines the data grid's boundaries.
javax.swing.JFrame	showLegend() Shows how values map to colors.
void	update() Updates this object's state using new data values.
int	xToIndex(double x) Gets closest index from the given x world coordinate.
int	yToIndex(double y) Gets closest index from the given y world coordinate.

Methods inherited from class org.opensourcephysics.display.MeasuredImage

getXMax, getXMin, getYMax, getYMin, isMeasured, setImage, setMinMax, setVisible, setXMax, setXMin, setYMax, setYMin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensourcephysics.display2d.Plot2D

setVisible

Methods inherited from interface org.opensourcephysics.display.Measurable

getXMax, getXMin, getYMax, getYMin, isMeasured

Constructor Detail

GridPlot

public GridPlot(GridData griddata)

Constructs the GridPlot using the given griddata.

Parameters:

griddata - the point data

GridPlot

public GridPlot()

Constructs a GridPlot without any data.

Method Detail

setIndexes

public void setIndexes(int[] indexes)

Sets the indexes for the data component that will be plotted.

Specified by:

setIndexes in interface Plot2D

Parameters:

indexes - the sample-component

getGridData

public GridData getGridData()

Gets the GridData object.

Specified by:

getGridData in interface Plot2D

Returns:

GridData

setGridData

public void setGridData(GridData _griddata)

Sets the data storage to the given value.

Specified by:

setGridData in interface Plot2D

Parameters:

_griddata - new data storage

indexToX

public double indexToX(int i)

Gets the x coordinate for the given index.

Specified by:

indexToX in interface Plot2D

Parameters:

i - int

Returns:

double the x coordinate

indexToY

public double indexToY(int i)

Gets the y coordinate for the given index.

Specified by:

indexToY in interface Plot2D

Parameters:

i - int

Returns:

double the y coordinate

xToIndex

public int xToIndex(double x)

Gets closest index from the given x world coordinate.

Specified by:

xToIndex in interface Plot2D

Parameters:

x - double the coordinate

Returns:

int the index

yToIndex

public int yToIndex(double y)

Gets closest index from the given y world coordinate.

Specified by:

yToIndex in interface Plot2D

Parameters:

y - double the coordinate

Returns:

int the index

setAll

public void setAll(java.lang.Object obj)

Sets the data to new values. The grid is resized to fit the new data if needed.

Specified by:

setAll in interface Plot2D

Parameters:

obj -

setAll

public void setAll(java.lang.Object obj,
                   double xmin,
                   double xmax,
                   double ymin,
                   double ymax)

Sets the values and the scale. The grid is resized to fit the new data if needed.

Specified by:

setAll in interface Plot2D

Parameters:

obj - array of new values

xmin - double

xmax - double

ymin - double

ymax - double

showLegend

public javax.swing.JFrame showLegend()

Shows how values map to colors.

Specified by:

showLegend in interface Plot2D

setAutoscaleZ

public void setAutoscaleZ(boolean isAutoscale,
                          double floor,
                          double ceil)

Sets the autoscale flag and the floor and ceiling values for the colors. If autoscaling is true, then the min and max values of z are span the colors. If autoscaling is false, then floor and ceiling values limit the colors. Values below min map to the first color; values above max map to the last color.

Specified by:

setAutoscaleZ in interface Plot2D

Parameters:

isAutoscale -

floor -

ceil -

isAutoscaleZ

public boolean isAutoscaleZ()

Gets the autoscale flag for z.

Specified by:

isAutoscaleZ in interface Plot2D

Returns:

boolean

getFloor

public double getFloor()

Gets the floor for scaling the z data.

Specified by:

getFloor in interface Plot2D

Returns:

double

getCeiling

public double getCeiling()

Gets the ceiling for scaling the z data.

Specified by:

getCeiling in interface Plot2D

Returns:

double

setPaletteType

public void setPaletteType(int type)

Determines the palette type that will be used.

Specified by:

setPaletteType in interface Plot2D

Parameters:

type -

setColorPalette

public void setColorPalette(java.awt.Color[] colors)

Sets the colors that will be used between the floor and ceiling values.

Specified by:

setColorPalette in interface Plot2D

Parameters:

colors -

setFloorCeilColor

public void setFloorCeilColor(java.awt.Color floorColor,
                              java.awt.Color ceilColor)

Sets the floor and ceiling colors.

Specified by:

setFloorCeilColor in interface Plot2D

Parameters:

floorColor -

ceilColor -

setShowGridLines

public void setShowGridLines(boolean showGrid)

Outlines the data grid's boundaries.

Specified by:

setShowGridLines in interface Plot2D

Parameters:

showGrid -

setGridLineColor

public void setGridLineColor(java.awt.Color c)

Sets the color for grid line boundaries

Specified by:

setGridLineColor in interface Plot2D

Parameters:

c -

setExpandedZ

public void setExpandedZ(boolean expanded,
                         double expansionFactor)

Expands the z scale so as to enhance values close to zero.

Specified by:

setExpandedZ in interface Plot2D

Parameters:

expanded - boolean

expansionFactor - double

update

public void update()

Updates this object's state using new data values. Update should be invoked if the data in the PointData object changes or if the z scale of the PointData object changes.

Specified by:

update in interface Plot2D

recolorImage

protected void recolorImage()

Recolors the image pixels using the data array.

draw

public void draw(DrawingPanel panel,
                 java.awt.Graphics g)

Draws the image and the grid.

Specified by:

draw in interface Drawable

Overrides:

draw in class MeasuredImage

Parameters:

panel -

g -

getLoader

public static XML.ObjectLoader getLoader()

Gets an XML.ObjectLoader to save and load data for this program.

Returns:

the object loader