org.das2.graph

Class SpectrogramRenderer

java.lang.Object

org.das2.graph.Renderer

org.das2.graph.SpectrogramRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer, TableDataSetConsumer

Direct Known Subclasses:

CollapseSpectrogramRenderer

public class SpectrogramRenderer
extends Renderer
implements TableDataSetConsumer, Displayable

Renderer for spectrograms. A setting for rebinning data controls how data is binned into pixel space, for example by nearest neighbor or interpolation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SpectrogramRenderer.RebinListener
static class	SpectrogramRenderer.RebinnerEnum

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cadenceCheck
static java.lang.String	CONTROL_KEY_REBIN
static java.lang.String	PROP_CADENCECHECK
static java.lang.String	PROP_REBINNER
static java.lang.String	PROP_SPECIALCOLORS

Fields inherited from class org.das2.graph.Renderer

bottomDecorator, colorBar, control, CONTROL_KEY_COLOR, CONTROL_KEY_COLOR_TABLE, CONTROL_KEY_DRAW_ERROR, CONTROL_KEY_FILL_COLOR, CONTROL_KEY_FILL_DIRECTION, CONTROL_KEY_FILL_TEXTURE, CONTROL_KEY_FONT_SIZE, CONTROL_KEY_LINE_STYLE, CONTROL_KEY_LINE_THICK, CONTROL_KEY_MODULO_X, CONTROL_KEY_MODULO_Y, CONTROL_KEY_REFERENCE, CONTROL_KEY_SPECIAL_COLORS, CONTROL_KEY_SYMBOL, CONTROL_KEY_SYMBOL_SIZE, drawLegendLabel, ds, firstValidIndex, id, lastException, lastValidIndex, legendLabel, MARKER_DATASET, MARKER_X_AXIS_RANGE, MARKER_Y_AXIS_RANGE, needWorkMarkers, PROP_ACTIVE, PROP_BOTTOMDECORATOR, PROP_COLORBAR, PROP_CONTROL, PROP_DRAWLEGENDLABEL, PROP_ID, PROP_LEGENDLABEL, PROP_RECORDFILE, PROP_TOPDECORATOR, propertyChangeSupport, renderException, topDecorator

Constructor Summary

Constructors

Constructor and Description
SpectrogramRenderer(DataSetDescriptor dsd, DasColorBar colorBar)

Method Summary

Modifier and Type	Method and Description
boolean	acceptContext(int x, int y) Returns true if the render will accept the context for a point.
protected void	clearPlotImage()
QDataSet	getConsumedDataSet() return the data for DataSetConsumer, which might be rebinned.
java.lang.String	getControl() get the string which summarizes the state of the renderer.
java.awt.Color	getFillColor() Getter for property fillColor.
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.
SpectrogramRenderer.RebinnerEnum	getRebinner() Getter for property rebinner.
java.lang.String	getSpecialColors()
DasAxis	getZAxis()
protected void	installRenderer()
boolean	isCadenceCheck()
boolean	isPrint300dpi() Getter for property draw300dpi.
boolean	isSliceRebinnedData() Getter for property sliceRebinnedData.
void	render(java.awt.Graphics2D g, DasAxis xAxis, DasAxis yAxis) Render is called whenever the image needs to be refreshed or the content has changed.
java.awt.Shape	selectionArea() return the shape or null.
void	setCadenceCheck(boolean cadenceCheck) If true, then use a cadence estimate to determine and indicate data gaps.
void	setColorBar(DasColorBar cb) set a colorbar for the renderer.
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	setFillColor(java.awt.Color fillColor) Setter for property fillColor.
void	setPrint300dpi(boolean print300dpi) Setter for property draw300dpi.
void	setRebinner(SpectrogramRenderer.RebinnerEnum rebinnerEnum) Setter for property rebinner.
void	setSliceRebinnedData(boolean sliceRebinnedData) Setter for property sliceRebinnedData.
void	setSpecialColors(java.lang.String specialColors) set this to a comma-delineated list of name:value pairs,
protected void	uninstallRenderer()
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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.das2.components.propertyeditor.Displayable

drawListIcon

Field Detail

CONTROL_KEY_REBIN

public static final java.lang.String CONTROL_KEY_REBIN

See Also:

Constant Field Values

PROP_SPECIALCOLORS

public static final java.lang.String PROP_SPECIALCOLORS

See Also:

Constant Field Values

PROP_REBINNER

public static final java.lang.String PROP_REBINNER

See Also:

Constant Field Values

cadenceCheck

protected boolean cadenceCheck

PROP_CADENCECHECK

public static final java.lang.String PROP_CADENCECHECK

See Also:

Constant Field Values

Constructor Detail

SpectrogramRenderer

public SpectrogramRenderer(DataSetDescriptor dsd,
                           DasColorBar colorBar)

Method Detail

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:

getSpecialColors

public java.lang.String getSpecialColors()

setSpecialColors

public void setSpecialColors(java.lang.String specialColors)

set this to a comma-delineated list of name:value pairs,

Parameters:

specialColors -

getZAxis

public DasAxis getZAxis()

Specified by:

getZAxis in interface TableDataSetConsumer

setColorBar

public void setColorBar(DasColorBar cb)

Description copied from class: Renderer

set a colorbar for the renderer. By default, the renderer simply ignores the colorbar, but instances may introduce special handling. WARNING: some subclasses override this, but do not call super.setColorBar.

Overrides:

setColorBar in class Renderer

Parameters:

cb - a colorbar

render

public void render(java.awt.Graphics2D g,
                   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:

g - 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

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

installRenderer

protected void installRenderer()

Overrides:

installRenderer in class Renderer

uninstallRenderer

protected void uninstallRenderer()

Overrides:

uninstallRenderer in class Renderer

getRebinner

public SpectrogramRenderer.RebinnerEnum getRebinner()

Getter for property rebinner.

Returns:

Value of property rebinner.

setRebinner

public final void setRebinner(SpectrogramRenderer.RebinnerEnum rebinnerEnum)

Setter for property rebinner.

Parameters:

rebinnerEnum - New value of property rebinner.

isSliceRebinnedData

public boolean isSliceRebinnedData()

Getter for property sliceRebinnedData.

Returns:

Value of property sliceRebinnedData.

setSliceRebinnedData

public void setSliceRebinnedData(boolean sliceRebinnedData)

Setter for property sliceRebinnedData.

Parameters:

sliceRebinnedData - New value of property sliceRebinnedData.

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.

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.

getConsumedDataSet

public QDataSet getConsumedDataSet()

Description copied from class: Renderer

return the data for DataSetConsumer, which might be rebinned.

Specified by:

getConsumedDataSet in interface DataSetConsumer

Overrides:

getConsumedDataSet in class Renderer

clearPlotImage

protected final void clearPlotImage()

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

isPrint300dpi

public boolean isPrint300dpi()

Getter for property draw300dpi.

Returns:

Value of property draw300dpi.

setPrint300dpi

public void setPrint300dpi(boolean print300dpi)

Setter for property draw300dpi.

Parameters:

print300dpi - New value of property draw300dpi.

isCadenceCheck

public boolean isCadenceCheck()

setCadenceCheck

public void setCadenceCheck(boolean cadenceCheck)

If true, then use a cadence estimate to determine and indicate data gaps.

Parameters:

cadenceCheck -

selectionArea

public java.awt.Shape selectionArea()

return the shape or null.

Returns:

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.

getFillColor

public java.awt.Color getFillColor()

Getter for property fillColor.

Returns:

Value of property fillColor.

setFillColor

public void setFillColor(java.awt.Color fillColor)

Setter for property fillColor.

Parameters:

fillColor - New value of property fillColor.