org.das2.graph

Class TickCurveRenderer

java.lang.Object

org.das2.graph.Renderer

org.das2.graph.TickCurveRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer

public final class TickCurveRenderer
extends Renderer

Renderer showing ticks along a curve, useful for orbits. Note this renderer assumes that someone else is showing the context, so just HH:MM is shown, assuming YYYY-MM-DD is shown elsewhere.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TickCurveRenderer.TickStyle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTROL_TICK_LENGTH
protected static java.util.logging.Logger	logger
static java.lang.String	PROP_FONTSIZE
static java.lang.String	PROP_TICK_STYLE
static java.lang.String	PROP_TICKDIRECTION
static java.lang.String	PROP_TICKSPACING
static java.lang.String	PROP_TICKVALUES

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
TickCurveRenderer()
TickCurveRenderer(QDataSet ds, java.lang.String xplane, java.lang.String yplane, TickVDescriptor tickv) Create a new renderer with the x and y planes of the bundle ds identified.

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.
static boolean	acceptsData(QDataSet ds) return true if the data is ds[:,3] (T,X,Y) or ds[x[t]] t→x→y
double	checkTickV(QDataSet tds) returns the minimal distance between consecutive ticks, or Double.MAX_VALUE if fewer than two ticks are found.
static QDataSet	doAutorange(QDataSet ds1) autorange on the data, returning a rank 2 bounds for the dataset.
java.awt.Color	getColor() get the color of the orbit
java.lang.String	getControl() get the string which summarizes the state of the renderer.
java.lang.String	getFontSize()
double	getLineWidth() Getter for property lineWidth.
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	getTickDirection()
TickLabeller	getTickLabeller() provide access to the tick labelling code
java.lang.String	getTickLength() Getter for property tickLength.
java.lang.String	getTickSpacing() get the spacing between ticks, which might be "" meaning automatic.
TickCurveRenderer.TickStyle	getTickStyle() Getter for property tickStyle.
java.lang.String	getTickValues()
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.
java.awt.Shape	selectionArea()
void	setColor(java.awt.Color color) set the color of the orbit
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	setFontSize(java.lang.String fontSize) relative font size.
void	setLineWidth(double lineWidth) Setter for property lineWidth.
void	setTickDirection(java.lang.String tickDirection)
void	setTickLabeller(TickLabeller tickLabeller) set the tick labelling code.
void	setTickLength(java.lang.String tickLength) Setter for property tickLength.
void	setTickSpacing(java.lang.String tickSpacing) set the spacing between ticks, for example "2hr" is every two hours, and an empty string is the default automatic behavior.
void	setTickStyle(TickCurveRenderer.TickStyle tickStyle) Setter for property tickStyle.
void	setTickValues(java.lang.String tickValues) set like the axis control, with values like: +2hr for every two hours 2019-11-26T00:02,2019-11-26T00:07 for explicit positions
void	setTickVDescriptor(TickVDescriptor ticks) manually set the ticks for the renderer, or null means use automatic.

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, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getInternalDataSet, getLastException, getLegendLabel, getListLabel, 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, setParent, setStatsFile, setTopDecorator, setUpFont, setUpFont, uninstallRenderer, update, updateCacheImage, updateImmediately, updatePlotImage

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

PROP_TICK_STYLE

public static final java.lang.String PROP_TICK_STYLE

See Also:

Constant Field Values

CONTROL_TICK_LENGTH

public static final java.lang.String CONTROL_TICK_LENGTH

See Also:

Constant Field Values

PROP_FONTSIZE

public static final java.lang.String PROP_FONTSIZE

See Also:

Constant Field Values

PROP_TICKDIRECTION

public static final java.lang.String PROP_TICKDIRECTION

See Also:

Constant Field Values

PROP_TICKSPACING

public static final java.lang.String PROP_TICKSPACING

See Also:

Constant Field Values

PROP_TICKVALUES

public static final java.lang.String PROP_TICKVALUES

See Also:

Constant Field Values

Constructor Detail

TickCurveRenderer

public TickCurveRenderer(QDataSet ds,
                         java.lang.String xplane,
                         java.lang.String yplane,
                         TickVDescriptor tickv)

Create a new renderer with the x and y planes of the bundle ds identified. If the xplane or yplane is not identified, then use unbundle(1) for the xplane and unbundle(y) for the yplane.

Parameters:

ds -

xplane -

yplane -

tickv - null or ticks for manual specification.

TickCurveRenderer

public TickCurveRenderer()

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:

getFontSize

public java.lang.String getFontSize()

setFontSize

public void setFontSize(java.lang.String fontSize)

relative font size.

Parameters:

fontSize -

See Also:

Renderer.CONTROL_KEY_FONT_SIZE

getTickDirection

public java.lang.String getTickDirection()

setTickDirection

public void setTickDirection(java.lang.String tickDirection)

acceptsData

public static boolean acceptsData(QDataSet ds)

return true if the data is ds[:,3] (T,X,Y) or ds[x[t]] t→x→y

Parameters:

ds - the dataset

Returns:

true if the data is ds[:,3] or ds[x[t]]

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.

selectionArea

public java.awt.Shape selectionArea()

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.

doAutorange

public static QDataSet doAutorange(QDataSet ds1)

autorange on the data, returning a rank 2 bounds for the dataset.

Parameters:

ds1 - the dataset

Returns:

rank 2 bounding box. r[0,0] is x min, r[0,1] is x max.

checkTickV

public double checkTickV(QDataSet tds)

returns the minimal distance between consecutive ticks, or Double.MAX_VALUE if fewer than two ticks are found.

Parameters:

tds -

Returns:

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

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

getTickLabeller

public TickLabeller getTickLabeller()

provide access to the tick labelling code

Returns:

setTickLabeller

public void setTickLabeller(TickLabeller tickLabeller)

set the tick labelling code. If this is an instance of GrannyTickLabeller, then a property change listener will be added.

Parameters:

tickLabeller -

getTickStyle

public TickCurveRenderer.TickStyle getTickStyle()

Getter for property tickStyle.

Returns:

Value of property tickStyle.

setTickStyle

public void setTickStyle(TickCurveRenderer.TickStyle tickStyle)

Setter for property tickStyle.

Parameters:

tickStyle - New value of property tickStyle.

getTickSpacing

public java.lang.String getTickSpacing()

get the spacing between ticks, which might be "" meaning automatic.

Returns:

setTickSpacing

public void setTickSpacing(java.lang.String tickSpacing)

set the spacing between ticks, for example "2hr" is every two hours, and an empty string is the default automatic behavior.

Parameters:

tickSpacing -

getTickValues

public java.lang.String getTickValues()

setTickValues

public void setTickValues(java.lang.String tickValues)

set like the axis control, with values like:

• +2hr for every two hours
• 2019-11-26T00:02,2019-11-26T00:07 for explicit positions

Parameters:

tickValues -

getLineWidth

public double getLineWidth()

Getter for property lineWidth.

Returns:

Value of property lineWidth.

setLineWidth

public void setLineWidth(double lineWidth)

Setter for property lineWidth.

Parameters:

lineWidth - New value of property lineWidth.

getColor

public java.awt.Color getColor()

get the color of the orbit

Returns:

the color

setColor

public void setColor(java.awt.Color color)

set the color of the orbit

Parameters:

color -

getTickLength

public java.lang.String getTickLength()

Getter for property tickLength.

Returns:

Value of property tickLength.

setTickLength

public void setTickLength(java.lang.String tickLength)

Setter for property tickLength.

Parameters:

tickLength - New value of property tickLength.

setTickVDescriptor

public void setTickVDescriptor(TickVDescriptor ticks)

manually set the ticks for the renderer, or null means use automatic.

Parameters:

ticks -