org.das2.graph

Class PitchAngleDistributionRenderer

java.lang.Object

org.das2.graph.Renderer

org.das2.graph.PitchAngleDistributionRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer

public class PitchAngleDistributionRenderer
extends Renderer

Draws a pitch angle distribution, which is a spectrogram wrapped around an origin. Datasets must be of the form Z[Angle,Radius]. The dataset Angle must be in radians (Units.radians or dimensionless), or have units Units.degrees. Note, at one time it would guess the angles dimension, but this was unreliable and was removed.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mirror if true, then mirror the image about angle=0.
protected java.lang.String	origin
protected boolean	originNorth
static java.lang.String	PROP_CLOCKWISE
static java.lang.String	PROP_DRAWPOLARAXES
static java.lang.String	PROP_MIRROR
static java.lang.String	PROP_ORIGIN One of "", "N", "S", "E", "W"
static java.lang.String	PROP_ORIGINNORTH if true, then angle=0 is in the positive Y direction, otherwise it is in the positive x direction

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, logger, 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
PitchAngleDistributionRenderer(DasColorBar cb)

Method Summary

Modifier and Type	Method and Description
static boolean	acceptsData(QDataSet ds) accepts data that is rank 2 and not a timeseries.
static QDataSet	doAutorange(QDataSet tds)
java.lang.String	getControl() get the string which summarizes the state of the renderer.
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	getOrigin()
protected void	installRenderer()
boolean	isClockwise() true if increasing angle corresponds to clockwise when not mirror.
boolean	isDrawPolarAxes()
boolean	isMirror()
boolean	isOriginNorth()
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	setClockwise(boolean clockwise) true if increasing angle corresponds to clockwise when not mirror.
void	setColorBar(DasColorBar colorBar) set a colorbar for the renderer.
void	setControl(java.lang.String s) set the control string which contains a number of properties.
void	setDrawPolarAxes(boolean drawPolarAxes)
void	setMirror(boolean mirror)
void	setOrigin(java.lang.String origin)
void	setOriginNorth(boolean originNorth)
protected void	uninstallRenderer()

Methods inherited from class org.das2.graph.Renderer

acceptContext, 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, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, parseLayoutString, postException, postMessage, postMessage, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setBottomDecorator, setDataSet, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setParent, setStatsFile, setTopDecorator, setUpFont, setUpFont, update, updateCacheImage, updateImmediately, updatePlotImage

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ORIGINNORTH

public static final java.lang.String PROP_ORIGINNORTH

if true, then angle=0 is in the positive Y direction, otherwise it is in the positive x direction

See Also:

Constant Field Values

originNorth

protected boolean originNorth

PROP_CLOCKWISE

public static final java.lang.String PROP_CLOCKWISE

See Also:

Constant Field Values

PROP_ORIGIN

public static final java.lang.String PROP_ORIGIN

One of "", "N", "S", "E", "W"

See Also:

Constant Field Values

origin

protected java.lang.String origin

PROP_DRAWPOLARAXES

public static final java.lang.String PROP_DRAWPOLARAXES

See Also:

Constant Field Values

mirror

protected boolean mirror

if true, then mirror the image about angle=0.

PROP_MIRROR

public static final java.lang.String PROP_MIRROR

See Also:

Constant Field Values

Constructor Detail

PitchAngleDistributionRenderer

public PitchAngleDistributionRenderer(DasColorBar cb)

Method Detail

acceptsData

public static boolean acceptsData(QDataSet ds)

accepts data that is rank 2 and not a timeseries. Angles may be in radians or in Units.degrees. ds[Energy,Pitch] or ds[Pitch,Energy] where Pitch is in: Units.degrees, Units.radians, or dimensionless and -2*PI to 2*PI.

Parameters:

ds -

Returns:

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.

setColorBar

public final void setColorBar(DasColorBar colorBar)

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:

colorBar - a colorbar

doAutorange

public static QDataSet doAutorange(QDataSet tds)

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

installRenderer

protected void installRenderer()

Overrides:

installRenderer in class Renderer

uninstallRenderer

protected void uninstallRenderer()

Overrides:

uninstallRenderer in class Renderer

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:

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

isOriginNorth

public boolean isOriginNorth()

setOriginNorth

public void setOriginNorth(boolean originNorth)

isClockwise

public boolean isClockwise()

true if increasing angle corresponds to clockwise when not mirror.

Returns:

true if increasing angle corresponds to clockwise

setClockwise

public void setClockwise(boolean clockwise)

true if increasing angle corresponds to clockwise when not mirror.

Parameters:

clockwise - true if increasing angle corresponds to clockwise

getOrigin

public java.lang.String getOrigin()

setOrigin

public void setOrigin(java.lang.String origin)

isDrawPolarAxes

public boolean isDrawPolarAxes()

setDrawPolarAxes

public void setDrawPolarAxes(boolean drawPolarAxes)

isMirror

public boolean isMirror()

setMirror

public void setMirror(boolean mirror)