uk.ac.starlink.ttools.plot2.layer
Class ContourStyle

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.layer.ContourStyle
All Implemented Interfaces:
Style

@Equality
public class ContourStyle
extends Object
implements Style

Style for contour plots.

Since:
17 Feb 2013
Author:
Mark Taylor

Constructor Summary
ContourStyle(Color color, int nLevel, double offset, int nSmooth, LevelMode levelMode)
          Constructor.
 
Method Summary
 boolean equals(Object o)
           
 Color getColor()
          Returns contour colour.
 Icon getLegendIcon()
          Returns an icon suitable for displaying in a legend for this style.
 int getLevelCount()
          Returns requested number of contours.
 LevelMode getLevelMode()
          Returns level determination algorithm.
 double getOffset()
          Returns the offset of the first contour from zero.
 int getSmoothing()
          Returns smoothing kernel width.
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContourStyle

public ContourStyle(Color color,
                    int nLevel,
                    double offset,
                    int nSmooth,
                    LevelMode levelMode)
Constructor.

Parameters:
color - contour line colour
nLevel - number of contours
offset - offset from zero of first contour; should be in the range 0..1
nSmooth - smoothing kernel width
levelMode - level determination algorithm
Method Detail

getColor

public Color getColor()
Returns contour colour.

Returns:
colour

getLevelCount

public int getLevelCount()
Returns requested number of contours.

Returns:
level count

getOffset

public double getOffset()
Returns the offset of the first contour from zero.

Returns:
zero offset, expected in the range 0..1

getSmoothing

public int getSmoothing()
Returns smoothing kernel width.

Returns:
smoothing amount; 1 means no smooth

getLevelMode

public LevelMode getLevelMode()
Returns level determination algorithm.

Returns:
level mode

getLegendIcon

public Icon getLegendIcon()
Description copied from interface: Style
Returns an icon suitable for displaying in a legend for this style.

Specified by:
getLegendIcon in interface Style

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.