Class graph.Contour
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class graph.Contour

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Canvas
                   |
                   +----graph.Graph2D
                           |
                           +----graph.G2Dint
                                   |
                                   +----graph.Contour

public class Contour
extends G2Dint
This class extends the interactive graphics class G2Dint to incorporate contouring.
Version:
1.11, 1996/08/12 23:37:08.
Author:
Leigh Brookshaw

Variable Index

 o autoLabels
If true the labels will be calculated for each contour level.
 o autoLevels
If set the class calculates the contour levels based on the data minimum and maximum.
 o contourColor
Color to draw non labelled contour line
 o curves
Vector array containing the Contour curves.
 o drawlabels
If false labels are not drawn
 o grid
The data grid, a 2D array stored in linear form.
 o gridLimits
 o labelcolor
Color to use in drawing Labels
 o labelfont
Font to use in drawing Labels
 o labelledColor
Color to draw labelled contour line
 o labelLevels
Which levels will get labels.
 o labelPrecision
Precision to use in drawing Labels.
 o labels
The label for each contour level
 o labelSignificant
Number of Significant figures to use in drawing Labels.
 o labelStyle
Style to use in drawing Labels.
 o levels
 o logLevels
 o noContours
Boolean value if true Contours will not be calculated
 o nx
Dimension of the contour grid in the X direction
 o ny
Dimension of the contour grid in the Y direction
 o xmax
The X maximum limit of the data grid
 o xmin
The X minimum limit of the data grid
 o ymax
The Y maximum limit of the data grid
 o ymin
The Y minimum limit of the data grid
 o zmax
The maximum value of the grid values
 o zmin
The minimum value of the grid values

Constructor Index

 o Contour()
Instantaite the class

Method Index

 o attachContours()
Attach contours so that they will be plotted.
 o calculateCurves()
 o deleteContours()
Delete all the Contours
 o detachContours()
Detach contours so that they will not be plotted.
 o getDim()
return the dimensions of the grid
 o getGrid()
Return the grid
 o getLabelPrecision()
Get the label precision.
 o getLabelSignificance()
Get the number of significant figures for labels.
 o getLabelStyle()
Get the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
 o getLevels()
Return the contour levels.
 o getRange()
Return the range of the grid
 o keyDown(Event, int)
Add extra events to the G2Dint event handler.
 o loadGrid(URL)
Load the grid to contour from a URL.
 o paintFirst(Graphics, Rectangle)
A hook into the Graph2D.paint method.
 o paintLast(Graphics, Rectangle)
A hook into the Graph2D.paint method.
 o setAutoLevels(boolean)
If true contour levels are calculated automatically.
 o setContourColor(Color)
Set the contour's color.
 o setDrawLabels(boolean)
If true contour levels are not labeled.
 o setGrid(double[], int, int)
Set the grid to be contoured.
 o setLabelColor(Color)
Set the Color to be used with all the labels.
 o setLabelFont(Font)
Set the font to be used with All the labels
 o setLabelledContourColor(Color)
Set the labelled contour's color.
 o setLabelLevels(int)
Set the contour levels that are to have labels.
 o setLabelPrecision(int)
Set the label precision.
 o setLabels(TextLine[], int)
Manually set the Contour labels.
 o setLabelSignificance(int)
Set the label significant figures.
 o setLabelStyle(int)
Set the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
 o setLevels(double[], int)
Manually set the contour levels.
 o setLimitsToGrid(boolean)
If true the limits of the plot will be the grid limits.
 o setLogLevels(boolean)
If true contour levels are calculated on a log scale.
 o setNLevels(int)
Set the number of contour levels.
 o setRange(double, double, double, double)
Set the range of the grid

Variables

 o nx
  protected int nx
Dimension of the contour grid in the X direction
 o ny
  protected int ny
Dimension of the contour grid in the Y direction
 o curves
  protected Vector curves[]
Vector array containing the Contour curves. Each index in the array contains curves at a given contour level
 o autoLevels
  protected boolean autoLevels
If set the class calculates the contour levels based on the data minimum and maximum. Default value true.
 o logLevels
  protected boolean logLevels
 o gridLimits
  protected boolean gridLimits
 o levels
  protected double levels[]
 o labels
  protected TextLine labels[]
The label for each contour level
 o labelfont
  protected Font labelfont
Font to use in drawing Labels
 o labelcolor
  protected Color labelcolor
Color to use in drawing Labels
 o labelStyle
  protected int labelStyle
Style to use in drawing Labels. TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
 o labelPrecision
  protected int labelPrecision
Precision to use in drawing Labels.
 o labelSignificant
  protected int labelSignificant
Number of Significant figures to use in drawing Labels.
 o labelLevels
  protected int labelLevels
Which levels will get labels. If it is equal to 1 every level gets a label, equal to 2 every second level etc. If it is equal to 0 no labels are displayed.
 o drawlabels
  protected boolean drawlabels
If false labels are not drawn
 o autoLabels
  protected boolean autoLabels
If true the labels will be calculated for each contour level. These might not look all that hot.
 o contourColor
  protected Color contourColor
Color to draw non labelled contour line
 o labelledColor
  protected Color labelledColor
Color to draw labelled contour line
 o grid
  protected double grid[]
The data grid, a 2D array stored in linear form. It is assumed that [0,0] is the bottom left corner and the data is ordered by row.
 o xmin
  protected double xmin
The X minimum limit of the data grid
 o xmax
  protected double xmax
The X maximum limit of the data grid
 o ymin
  protected double ymin
The Y minimum limit of the data grid
 o ymax
  protected double ymax
The Y maximum limit of the data grid
 o zmin
  protected double zmin
The minimum value of the grid values
 o zmax
  protected double zmax
The maximum value of the grid values
 o noContours
  public boolean noContours
Boolean value if true Contours will not be calculated

Constructors

 o Contour
  public Contour()
Instantaite the class

Methods

 o loadGrid
  public boolean loadGrid(URL file)
Load the grid to contour from a URL. There are 2 formats for the data optionally the limits of the grid can be parsed.
 The expected format of the data 
          1st Number:   nx
          2nd Number:   ny
          nx*ny numbers following
 Optionally
          1st Number:   nx
          2nd Number:   ny
          3rd Number:   xmin
          4th Number:   xmax
          5th Number:   ymin
          6th Number:   ymax
          nx*ny numbers following
 

If xmin, xmax, ymin, ymax are not specified they are assumed to be [1.0,nx,1.0,ny]
Parameters:
file - URL of the file to load
Returns:
true of the load was successful.
 o setRange
  public void setRange(double xmin,
                       double xmax,
                       double ymin,
                       double ymax)
Set the range of the grid
Parameters:
xmin - Minimum X value
xmax - Maximum X value
ymin - Minimum Y value
ymax - Maximum Y value
 o getRange
  public double[] getRange()
Return the range of the grid
Returns:
An array contining xmin,xmax,ymin,ymax.
 o getDim
  public int[] getDim()
return the dimensions of the grid
Returns:
An array containing the number of columns, number of rows.
 o getGrid
  public double[] getGrid()
Return the grid
Returns:
An array of size nx by ny contining the data grid.
 o setLevels
  public void setLevels(double levels[],
                        int nl)
Manually set the contour levels.
Parameters:
levels - An array containing the contour levels
nl - The number of contour levels in the arrray
 o setLabels
  public void setLabels(TextLine labels[],
                        int nl)
Manually set the Contour labels.
Parameters:
labels - An array containing the labels.
nl - Number of labels in the Array.
 o setLabelFont
  public void setLabelFont(Font f)
Set the font to be used with All the labels
Parameters:
f - Font
 o setLabelColor
  public void setLabelColor(Color c)
Set the Color to be used with all the labels.
Parameters:
c - Color
 o setGrid
  public void setGrid(double grid[],
                      int nx,
                      int ny)
Set the grid to be contoured.
Parameters:
grid - Array of values
nx - Number of columns
ny - Number of rows
 o deleteContours
  public void deleteContours()
Delete all the Contours
 o detachContours
  public void detachContours()
Detach contours so that they will not be plotted.
 o attachContours
  public void attachContours()
Attach contours so that they will be plotted.
 o setContourColor
  public void setContourColor(Color c)
Set the contour's color.
Parameters:
c - Color
 o setLabelledContourColor
  public void setLabelledContourColor(Color c)
Set the labelled contour's color.
Parameters:
c - Color
 o getLevels
  public double[] getLevels()
Return the contour levels.
Returns:
An array containing the contour levels
 o setLimitsToGrid
  public void setLimitsToGrid(boolean b)
If true the limits of the plot will be the grid limits. If false the limits of the plot will be the contours.
Parameters:
b - boolean
 o setLabelLevels
  public void setLabelLevels(int i)
Set the contour levels that are to have labels.
   if 0 no labels are drawn
   if 1 every level gets a label
   If 2 every 2nd level gets a label
   etc.
 o setLogLevels
  public void setLogLevels(boolean b)
If true contour levels are calculated on a log scale.
Parameters:
b - boolean
 o setNLevels
  public void setNLevels(int l)
Set the number of contour levels.
 o setAutoLevels
  public void setAutoLevels(boolean b)
If true contour levels are calculated automatically.
Parameters:
b - boolean
 o setDrawLabels
  public void setDrawLabels(boolean b)
If true contour levels are not labeled.
Parameters:
b - boolean
 o setLabelStyle
  public void setLabelStyle(int s)
Set the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
Parameters:
s - Style
 o getLabelStyle
  public int getLabelStyle()
Get the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
Returns:
style
 o setLabelPrecision
  public void setLabelPrecision(int p)
Set the label precision.
Parameters:
s - Precision
 o getLabelPrecision
  public int getLabelPrecision()
Get the label precision.
Returns:
precision
 o setLabelSignificance
  public void setLabelSignificance(int s)
Set the label significant figures.
Parameters:
s - number of significant figures
 o getLabelSignificance
  public int getLabelSignificance()
Get the number of significant figures for labels.
Returns:
number of significant figures
 o keyDown
  public boolean keyDown(Event e,
                         int key)
Add extra events to the G2Dint event handler. If 'l' is pressed repaint without the labels If 'L' is pressed repaint with the labels.
Overrides:
keyDown in class G2Dint
 o paintFirst
  public void paintFirst(Graphics g,
                         Rectangle r)
A hook into the Graph2D.paint method.
Overrides:
paintFirst in class Graph2D
 o paintLast
  public void paintLast(Graphics g,
                        Rectangle rect)
A hook into the Graph2D.paint method.
Overrides:
paintLast in class Graph2D
 o calculateCurves
  protected void calculateCurves()

All Packages  Class Hierarchy  This Package  Previous  Next  Index