Package 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

  • Constructor Details

    • 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 Details

    • 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(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(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 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 -

    • setSymmetricZ

      public void setSymmetricZ(boolean symmetric)
      Forces the z-scale to be symmetric about zero. Forces zmax to be positive and zmin=-zmax when in autoscale mode.
      Specified by:
      setSymmetricZ in interface Plot2D
      Parameters:
      symmetric -

    • isSymmetricZ

      public boolean isSymmetricZ()
      Gets the symmetric z flag.
      Specified by:
      isSymmetricZ in interface Plot2D

    • 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(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(Color floorColor, 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(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, 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