Contour

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible
```
public class Contour
extends G2Dint
```
This class extends the interactive graphics class G2Dint to incorporate contouring.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Component
  Component.BaselineResizeBehavior

Field Summary

Fields
Modifier and Type Field and Description

boolean noContours
Boolean value if true Contours will not be calculated
- Fields inherited from class graph.Graph2D
  borderBottom, borderLeft, borderRight, borderTop, clearAll, datarect, drawgrid, drawzero, frame, framecolor, gridcolor, lastText, loadingData, paintAll, square, zerocolor
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields
Modifier and Type	Field and Description
`boolean`	`noContours` Boolean value if true Contours will not be calculated

Constructor Summary

Constructors
Constructor and Description

Contour()
Instantaite the class

Constructors
Constructor and Description
`Contour()` Instantaite the class

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachContours()` Attach contours so that they will be plotted.
`void`	`deleteContours()` Delete all the Contours
`void`	`detachContours()` Detach contours so that they will not be plotted.
`int[]`	`getDim()` return the dimensions of the grid
`double[]`	`getGrid()` Return the grid
`int`	`getLabelPrecision()` Get the label precision.
`int`	`getLabelSignificance()` Get the number of significant figures for labels.
`int`	`getLabelStyle()` Get the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
`double[]`	`getLevels()` Return the contour levels.
`double[]`	`getRange()` Return the range of the grid
`boolean`	`keyDown(Event e, int key)` Add extra events to the G2Dint event handler.
`boolean`	`loadGrid(URL file)` Load the grid to contour from a URL.
`void`	`paintFirst(Graphics g, Rectangle r)` A hook into the Graph2D.paint method.
`void`	`paintLast(Graphics g, Rectangle rect)` A hook into the Graph2D.paint method.
`void`	`setAutoLevels(boolean b)` If true contour levels are calculated automatically.
`void`	`setContourColor(Color c)` Set the contour's color.
`void`	`setDrawLabels(boolean b)` If true contour levels are not labeled.
`void`	`setGrid(double[] grid, int nx, int ny)` Set the grid to be contoured.
`void`	`setLabelColor(Color c)` Set the Color to be used with all the labels.
`void`	`setLabelFont(Font f)` Set the font to be used with All the labels
`void`	`setLabelledContourColor(Color c)` Set the labelled contour's color.
`void`	`setLabelLevels(int i)` Set the contour levels that are to have labels.
`void`	`setLabelPrecision(int p)` Set the label precision.
`void`	`setLabels(TextLine[] labels, int nl)` Manually set the Contour labels.
`void`	`setLabelSignificance(int s)` Set the label significant figures.
`void`	`setLabelStyle(int s)` Set the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
`void`	`setLevels(double[] levels, int nl)` Manually set the contour levels.
`void`	`setLimitsToGrid(boolean b)` If true the limits of the plot will be the grid limits.
`void`	`setLogLevels(boolean b)` If true contour levels are calculated on a log scale.
`void`	`setNLevels(int l)` Set the number of contour levels.
`void`	`setRange(double xmin, double xmax, double ymin, double ymax)` Set the range of the grid

Methods inherited from class graph.G2Dint
action, attachAxis, createXAxis, createYAxis, mouseDown, mouseDrag, mouseMove, mouseUp, update

Methods inherited from class graph.Graph2D
attachDataSet, createAxis, detachAxes, detachAxis, detachDataSet, detachDataSets, finishedloading, getMarkers, getXmax, getXmin, getYmax, getYmin, loadDataSet, loadFile, loadmessage, paint, paintBeforeData, setDataBackground, setGraphBackground, setMarkers, startedloading

Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class java.awt.Component
add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseEnter, mouseExit, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - noContours
```
public boolean noContours
```
    Boolean value if true Contours will not be calculated
- Constructor Detail
  - Contour
```
public Contour()
```
    Instantaite the class
- Method Detail
  - 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.
  - 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
  - getRange
```
public double[] getRange()
```
    Return the range of the grid
    
    Returns:
    
    An array contining xmin,xmax,ymin,ymax.
  - getDim
```
public int[] getDim()
```
    return the dimensions of the grid
    
    Returns:
    
    An array containing the number of columns, number of rows.
  - getGrid
```
public double[] getGrid()
```
    Return the grid
    
    Returns:
    
    An array of size nx by ny contining the data grid.
  - 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
  - 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.
  - setLabelFont
```
public void setLabelFont(Font f)
```
    Set the font to be used with All the labels
    
    Parameters:
    
    f - Font
  - setLabelColor
```
public void setLabelColor(Color c)
```
    Set the Color to be used with all the labels.
    
    Parameters:
    
    c - Color
  - 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
  - deleteContours
```
public void deleteContours()
```
    Delete all the Contours
  - detachContours
```
public void detachContours()
```
    Detach contours so that they will not be plotted.
  - attachContours
```
public void attachContours()
```
    Attach contours so that they will be plotted.
  - setContourColor
```
public void setContourColor(Color c)
```
    Set the contour's color.
    
    Parameters:
    
    c - Color
  - setLabelledContourColor
```
public void setLabelledContourColor(Color c)
```
    Set the labelled contour's color.
    
    Parameters:
    
    c - Color
  - getLevels
```
public double[] getLevels()
```
    Return the contour levels.
    
    Returns:
    
    An array containing the contour levels
  - 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
  - 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.
 
```
  - setLogLevels
```
public void setLogLevels(boolean b)
```
    If true contour levels are calculated on a log scale.
    
    Parameters:
    
    b - boolean
  - setNLevels
```
public void setNLevels(int l)
```
    Set the number of contour levels.
  - setAutoLevels
```
public void setAutoLevels(boolean b)
```
    If true contour levels are calculated automatically.
    
    Parameters:
    
    b - boolean
  - setDrawLabels
```
public void setDrawLabels(boolean b)
```
    If true contour levels are not labeled.
    
    Parameters:
    
    b - boolean
  - setLabelStyle
```
public void setLabelStyle(int s)
```
    Set the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
    
    Parameters:
    
    s - Style
  - getLabelStyle
```
public int getLabelStyle()
```
    Get the label style, either TextLine.SCIENTIFIC or TextLine.ALGEBRAIC.
    
    Returns:
    
    style
  - setLabelPrecision
```
public void setLabelPrecision(int p)
```
    Set the label precision.
    
    Parameters:
    
    s - Precision
  - getLabelPrecision
```
public int getLabelPrecision()
```
    Get the label precision.
    
    Returns:
    
    precision
  - setLabelSignificance
```
public void setLabelSignificance(int s)
```
    Set the label significant figures.
    
    Parameters:
    
    s - number of significant figures
  - getLabelSignificance
```
public int getLabelSignificance()
```
    Get the number of significant figures for labels.
    
    Returns:
    
    number of significant figures
  - 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
  - paintFirst
```
public void paintFirst(Graphics g,
                       Rectangle r)
```
    Description copied from class: Graph2D
    
    A hook into the Graph2D.paint method. This is called before anything is plotted. The rectangle passed is the dimension of the canvas minus the border dimensions.
    
    Overrides:
    
    paintFirst in class Graph2D
  - paintLast
```
public void paintLast(Graphics g,
                      Rectangle rect)
```
    Description copied from class: Graph2D
    
    A hook into the Graph2D.paint method. This is called after everything has been drawn. The rectangle passed is the dimension of the data window.
    
    Overrides:
    
    paintLast in class Graph2D

Class Contour

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class graph.Graph2D

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class graph.G2Dint

Methods inherited from class graph.Graph2D

Methods inherited from class java.awt.Canvas

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

noContours

Constructor Detail

Contour

Method Detail

loadGrid

setRange

getRange

getDim

getGrid

setLevels

setLabels

setLabelFont

setLabelColor

setGrid

deleteContours

detachContours

attachContours

setContourColor

setLabelledContourColor

getLevels

setLimitsToGrid

setLabelLevels

setLogLevels

setNLevels

setAutoLevels

setDrawLabels

setLabelStyle

getLabelStyle

setLabelPrecision

getLabelPrecision

setLabelSignificance

getLabelSignificance

keyDown

paintFirst

paintLast