ContoursRenderer

java.lang.Object
- org.das2.graph.Renderer
- - org.das2.graph.ContoursRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer
```
public class ContoursRenderer
extends Renderer
```
Renderer for making contour plots.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONTROL_KEY_FORMAT`
`static java.lang.String`	`CONTROL_KEY_LABEL_CADENCE`
`static java.lang.String`	`CONTROL_KEY_LABEL_ORIENT`
`static java.lang.String`	`CONTROL_KEY_LABELS`
`static java.lang.String`	`CONTROL_KEY_LEVELS`
`protected static java.util.logging.Logger`	`logger`
`static java.lang.String`	`PROP_FONTSIZE`
`static java.lang.String`	`PROP_FORMAT` format, empty string means use the default format.
`static java.lang.String`	`PROP_LABELORIENT`
`static java.lang.String`	`PROP_LINESTYLE`
`static java.lang.String`	`PROP_LINETHICK` handle for the property lineThick.
`static java.lang.String`	`PROP_SIMPLIFYPATHS`

Constructor Summary

Constructors
Constructor and Description

ContoursRenderer()

Constructors
Constructor and Description
`ContoursRenderer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptContext(int x, int y)` Returns true if the render will accept the context for a point.
`boolean`	`acceptsDataSet(QDataSet ds)` return true if the dataset appears to be in a scheme accepted by this renderer.
`static QDataSet`	`doAutorange(QDataSet ds)` autorange on the data, returning a rank 2 bounds for the dataset.
`java.awt.Color`	`getColor()` Get the color for contour lines
`java.lang.String`	`getContours()` return the contour locations, a comma-separated list
`java.lang.String`	`getControl()` get the string which summarizes the state of the renderer.
`java.lang.String`	`getFontSize()`
`java.lang.String`	`getFormat()`
`java.lang.String`	`getLabelCadence()` return the inter-label distance, in ems.
`java.lang.String`	`getLabelOrient()`
`PsymConnector`	`getLineStyle()`
`double`	`getLineThick()` get the line thickness in pixels.
`javax.swing.Icon`	`getListIcon()` An icon can be provided that will be shown in a list along with the textual description of the element.
`java.lang.String`	`getListLabel()` return a `String` that will help the user identify this item when choosing from a list.
`boolean`	`isDrawLabels()` true if labels should be drawn.
`boolean`	`isSimplifyPaths()` return true if we should reduce paths to remove features that fall within a pixel, etc.
`void`	`render(java.awt.Graphics2D g1, DasAxis xAxis, DasAxis yAxis)` Render is called whenever the image needs to be refreshed or the content has changed.
`void`	`setColor(java.awt.Color color)` Set the color for contour lines
`void`	`setContours(java.lang.String contours)` set the contour locations, a comma-separated list
`void`	`setControl(java.lang.String s)` set the control string which contains a number of properties.
`void`	`setDataSet(QDataSet ds)` Set the dataset to be plotted.
`void`	`setDrawLabels(boolean drawLabels)` true if labels should be drawn.
`void`	`setFontSize(java.lang.String fontSize)`
`void`	`setFormat(java.lang.String value)` explicitly set the format.
`void`	`setLabelCadence(java.lang.String labelCadence)` set the inter-label distance, in ems.
`void`	`setLabelOrient(java.lang.String labelOrient)`
`void`	`setLineStyle(PsymConnector lineStyle)`
`void`	`setLineThick(double newlineThick)` set the line thickness in pixels.
`void`	`setParent(DasPlot parent)`
`void`	`setSimplifyPaths(boolean newsimplifyPaths)` set to true if we should reduce paths to remove features that fall within a pixel, etc.
`void`	`updatePlotImage(DasAxis xAxis, DasAxis yAxis, ProgressMonitor monitor)` updatePlotImage is called once the expensive operation of loading the data is completed.

Methods inherited from class org.das2.graph.Renderer
addPropertyChangeListener, addPropertyChangeListener, addToStats, decodeDatum, decodeFillStyle, decodePlotSymbolConnectorControl, decodePlotSymbolControl, drawListIcon, encodeBooleanControl, encodeColorControl, encodeDatum, encodeFillStyle, encodePlotSymbolConnectorControl, encodePlotSymbolControl, formatControl, getAffineTransform, getBooleanControl, getBottomDecorator, getColorBar, getColorControl, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getInternalDataSet, getLastException, getLegendLabel, getParent, getRenderCount, getStatsFile, getTopDecorator, getUpdateCount, getXmemento, getYmemento, hasControl, incrementRenderCount, incrementUpdateCount, installRenderer, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, parseLayoutString, postException, postMessage, postMessage, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setBottomDecorator, setColorBar, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setStatsFile, setTopDecorator, setUpFont, setUpFont, uninstallRenderer, update, updateCacheImage, updateImmediately

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

- Field Detail
  - logger
```
protected static final java.util.logging.Logger logger
```
  - CONTROL_KEY_LEVELS
```
public static final java.lang.String CONTROL_KEY_LEVELS
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_LABELS
```
public static final java.lang.String CONTROL_KEY_LABELS
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_LABEL_CADENCE
```
public static final java.lang.String CONTROL_KEY_LABEL_CADENCE
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_FORMAT
```
public static final java.lang.String CONTROL_KEY_FORMAT
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_LABEL_ORIENT
```
public static final java.lang.String CONTROL_KEY_LABEL_ORIENT
```
    See Also:
    
    Constant Field Values
  - PROP_FONTSIZE
```
public static final java.lang.String PROP_FONTSIZE
```
    See Also:
    
    Constant Field Values
  - PROP_FORMAT
```
public static final java.lang.String PROP_FORMAT
```
    format, empty string means use the default format.
    
    See Also:
    
    Constant Field Values
  - PROP_LABELORIENT
```
public static final java.lang.String PROP_LABELORIENT
```
    See Also:
    
    Constant Field Values
  - PROP_SIMPLIFYPATHS
```
public static final java.lang.String PROP_SIMPLIFYPATHS
```
    See Also:
    
    Constant Field Values
  - PROP_LINETHICK
```
public static final java.lang.String PROP_LINETHICK
```
    handle for the property lineThick.
    
    See Also:
    
    Constant Field Values
  - PROP_LINESTYLE
```
public static final java.lang.String PROP_LINESTYLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ContoursRenderer
```
public ContoursRenderer()
```
- Method Detail
  - doAutorange
```
public static QDataSet doAutorange(QDataSet ds)
```
    autorange on the data, returning a rank 2 bounds for the dataset.
    
    Parameters:
    
    ds - the dataset.
    
    Returns:
    
    a bounding box
    
    See Also:
    
    Schemes.boundingBox()
  - setParent
```
public void setParent(DasPlot parent)
```
    Overrides:
    
    setParent in class Renderer
  - render
```
public void render(java.awt.Graphics2D g1,
                   DasAxis xAxis,
                   DasAxis yAxis)
```
    Description copied from class: Renderer
    
    Render is called whenever the image needs to be refreshed or the content has changed. This operation should occur with an animation-interactive time scale, and an image should be cached when this is not possible. The graphics object will have its origin at the upper-left corner of the screen.
    
    Specified by:
    
    render in class Renderer
    
    Parameters:
    
    g1 - the graphics context in the canvas reference frame.
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
  - setControl
```
public void setControl(java.lang.String s)
```
    Description copied from class: Renderer
    
    set the control string which contains a number of properties. These are defined for each renderer, but they should try to be consistent. See http://autoplot.org/developer.guessRenderType#Proposed_extensions When overriding this, be sure to call super.
    
    Overrides:
    
    setControl in class Renderer
    
    Parameters:
    
    s - the control
    
    See Also:
    
    etc
  - getControl
```
public java.lang.String getControl()
```
    Description copied from class: Renderer
    
    get the string which summarizes the state of the renderer. These allow a compact string to contain the renderer settings. This should be an ampersand-delimited list of name=value pairs.
    
    Overrides:
    
    getControl in class Renderer
    
    Returns:
  - acceptsDataSet
```
public boolean acceptsDataSet(QDataSet ds)
```
    Description copied from class: Renderer
    
    return true if the dataset appears to be in a scheme accepted by this renderer. This should assume that axis units can be reset, etc.
    
    Overrides:
    
    acceptsDataSet in class Renderer
    
    Returns:
    
    true if the dataset appears to be acceptable.
  - setDataSet
```
public void setDataSet(QDataSet ds)
```
    Description copied from class: Renderer
    
    Set the dataset to be plotted. Different renderers accept QDataSets with different schemes. For example SeriesRenderer takes: ds[t] rank 1 dataset with rank 1 DEPEND_0 or ds[t,n] rank 2 bundle dataset with X in ds[t,0] and Y in ds[t,n-1] and SpectrogramRenderer takes: ds[t,y] rank 2 table dataset ds[n,t,y] rank 3 dataset with the first dimension join See each renderer's documentation for the schemes it takes. Note the lastException property is cleared, even when the dataset is null.
    
    Overrides:
    
    setDataSet in class Renderer
  - getFontSize
```
public java.lang.String getFontSize()
```
  - setFontSize
```
public void setFontSize(java.lang.String fontSize)
```
  - getFormat
```
public java.lang.String getFormat()
```
  - setFormat
```
public void setFormat(java.lang.String value)
```
    explicitly set the format. format is found there.
    
    Parameters:
    
    value -
  - getLabelOrient
```
public java.lang.String getLabelOrient()
```
  - setLabelOrient
```
public void setLabelOrient(java.lang.String labelOrient)
```
  - getListIcon
```
public javax.swing.Icon getListIcon()
```
    Description copied from interface: Displayable
    
    An icon can be provided that will be shown in a list along with the textual description of the element. This method should return null if there is no icon available, or a roughly 16x16 pixel icon.
    
    Specified by:
    
    getListIcon in interface Displayable
    
    Overrides:
    
    getListIcon in class Renderer
    
    Returns:
    
    the icon.
  - getListLabel
```
public java.lang.String getListLabel()
```
    Description copied from interface: Displayable
    
    return a String that will help the user identify this item when choosing from a list.
    
    Specified by:
    
    getListLabel in interface Displayable
    
    Overrides:
    
    getListLabel in class Renderer
    
    Returns:
    
    the list label.
  - updatePlotImage
```
public void updatePlotImage(DasAxis xAxis,
                            DasAxis yAxis,
                            ProgressMonitor monitor)
                     throws DasException
```
    Description copied from class: Renderer
    
    updatePlotImage is called once the expensive operation of loading the data is completed. This operation should occur on an interactive time scale. This is an opportunity to create a cache image of the data with the current axis state, when the render operation cannot operate on an animation interactive time scale. Also, several Renders can be updating at once on separate threads, while the render methods must be called sequentially. Only Renderer should call this method! (This should be protected then, but this is not possible because of exiting use. TODO: introduce "revalidate" to replace this operation.)
    
    Overrides:
    
    updatePlotImage in class Renderer
    
    Parameters:
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
    
    monitor - a monitor for the operation. Note the updatePlotImage operation should be fast (<1000ms).
    
    Throws:
    
    DasException
  - getContours
```
public java.lang.String getContours()
```
    return the contour locations, a comma-separated list
    
    Returns:
    
    the contour locations, a comma-separated list
  - setContours
```
public void setContours(java.lang.String contours)
```
    set the contour locations, a comma-separated list
    
    Parameters:
    
    contours - the contour locations, a comma-separated list
  - getLabelCadence
```
public java.lang.String getLabelCadence()
```
    return the inter-label distance, in ems.
    
    Returns:
    
    get the inter-label distance, in ems.
  - setLabelCadence
```
public void setLabelCadence(java.lang.String labelCadence)
```
    set the inter-label distance, in ems.
    
    Parameters:
    
    labelCadence - the inter-label distance, in ems.
  - acceptContext
```
public boolean acceptContext(int x,
                             int y)
```
    Description copied from class: Renderer
    
    Returns true if the render will accept the context for a point. That is, the renderer affected that point, or nearby points. This is used currently to provide a way for the operator to click on a plot and directly edit the renderer which drew the pixel.
    
    Overrides:
    
    acceptContext in class Renderer
    
    Parameters:
    
    x - the x coordinate in the canvas coordinate system.
    
    y - the y coordinate in the canvas coordinate system.
    
    Returns:
    
    true if the renderer will accept the context.
  - isDrawLabels
```
public boolean isDrawLabels()
```
    true if labels should be drawn.
    
    Returns:
    
    true if labels should be drawn.
  - setDrawLabels
```
public void setDrawLabels(boolean drawLabels)
```
    true if labels should be drawn.
    
    Parameters:
    
    drawLabels - true if labels should be drawn.
  - getColor
```
public java.awt.Color getColor()
```
    Get the color for contour lines
    
    Returns:
    
    the color for contour lines
  - setColor
```
public void setColor(java.awt.Color color)
```
    Set the color for contour lines
    
    Parameters:
    
    color - the color for contour lines
  - isSimplifyPaths
```
public boolean isSimplifyPaths()
```
    return true if we should reduce paths to remove features that fall within a pixel, etc.
    
    Returns:
    
    true if we should reduce paths
  - setSimplifyPaths
```
public void setSimplifyPaths(boolean newsimplifyPaths)
```
    set to true if we should reduce paths to remove features that fall within a pixel, etc.
    
    Parameters:
    
    newsimplifyPaths - true if we should reduce paths
  - getLineThick
```
public double getLineThick()
```
    get the line thickness in pixels.
    
    Returns:
    
    the line thickness in pixels.
  - setLineThick
```
public void setLineThick(double newlineThick)
```
    set the line thickness in pixels.
    
    Parameters:
    
    newlineThick - the line thickness in pixels.
  - getLineStyle
```
public PsymConnector getLineStyle()
```
  - setLineStyle
```
public void setLineStyle(PsymConnector lineStyle)
```

Class ContoursRenderer

Field Summary

Fields inherited from class org.das2.graph.Renderer

Constructor Summary

Method Summary

Methods inherited from class org.das2.graph.Renderer

Methods inherited from class java.lang.Object

Field Detail

logger

CONTROL_KEY_LEVELS

CONTROL_KEY_LABELS

CONTROL_KEY_LABEL_CADENCE

CONTROL_KEY_FORMAT

CONTROL_KEY_LABEL_ORIENT

PROP_FONTSIZE

PROP_FORMAT

PROP_LABELORIENT

PROP_SIMPLIFYPATHS

PROP_LINETHICK

PROP_LINESTYLE

Constructor Detail

ContoursRenderer

Method Detail

doAutorange

setParent

render

setControl

getControl

acceptsDataSet

setDataSet

getFontSize

setFontSize

getFormat

setFormat

getLabelOrient

setLabelOrient

getListIcon

getListLabel

updatePlotImage

getContours

setContours

getLabelCadence

setLabelCadence

acceptContext

isDrawLabels

setDrawLabels

getColor

setColor

isSimplifyPaths

setSimplifyPaths

getLineThick

setLineThick

getLineStyle

setLineStyle