PolarPlotRenderer

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

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer
```
public class PolarPlotRenderer
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_LINEWIDTH`
`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

Constructor Summary

Constructors
Constructor and Description

PolarPlotRenderer(DasColorBar cb)

Constructors
Constructor and Description
`PolarPlotRenderer(DasColorBar cb)`

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.
`static boolean`	`acceptsData(QDataSet ds)` accepts data that is rank 2 and not a timeseries.
`static QDataSet`	`doAutorange(QDataSet tds)`
`java.awt.Color`	`getColor()` Get the color for contour lines
`java.lang.String`	`getControl()` get the string which summarizes the state of the renderer.
`double`	`getLineWidth()` get the width, in pixels of the contour lines.
`javax.swing.Icon`	`getListIcon()` experiment with drawing the list icon dynamically.
`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.Graphics g1, DasAxis xAxis, DasAxis yAxis, ProgressMonitor mon)` Render is called whenever the image needs to be refreshed or the content has changed.
`java.awt.Shape`	`selectionArea()`
`void`	`setClockwise(boolean clockwise)` true if increasing angle corresponds to clockwise when not mirror.
`void`	`setColor(java.awt.Color color)` Set the color for contour lines
`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`	`setLineWidth(double lineWidth)`
`void`	`setMirror(boolean mirror)`
`void`	`setOrigin(java.lang.String origin)`
`void`	`setOriginNorth(boolean originNorth)`
`protected void`	`uninstallRenderer()`
`void`	`update()` Something has changed with the Render, and the plot should come back to allow this render to repaint.

Methods inherited from class org.das2.graph.Renderer
acceptsDataSet, addPropertyChangeListener, addPropertyChangeListener, decodePlotSymbolControl, drawListIcon, encodeBooleanControl, encodeColorControl, encodePlotSymbolControl, formatControl, getAffineTransform, getBooleanControl, getColorBar, getColorControl, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getLastException, getLegendLabel, getListLabel, getParent, getRenderCount, getTopDecorator, getUpdateCount, getXmemento, getYmemento, hasControl, incrementRenderCount, incrementUpdateCount, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setDataSet, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setParent, setTopDecorator, setUpFont, setUpFont, updateCacheImage, updateImmediately, updatePlotImage

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

- Field Detail
  - PROP_LINEWIDTH
```
public static final java.lang.String PROP_LINEWIDTH
```
    See Also:
    
    Constant Field Values
  - 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
  - PolarPlotRenderer
```
public PolarPlotRenderer(DasColorBar cb)
```
- Method Detail
  - getListIcon
```
public javax.swing.Icon getListIcon()
```
    experiment with drawing the list icon dynamically.
    
    Specified by:
    
    getListIcon in interface Displayable
    
    Overrides:
    
    getListIcon in class Renderer
    
    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.
  - selectionArea
```
public java.awt.Shape selectionArea()
```
  - 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:
  - 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
  - update
```
public void update()
```
    Description copied from class: Renderer
    
    Something has changed with the Render, and the plot should come back to allow this render to repaint. Its cacheImage is invalidated and a repaint is posted on the event thread.
    
    Overrides:
    
    update in class Renderer
  - getLineWidth
```
public double getLineWidth()
```
    get the width, in pixels of the contour lines.
    
    Returns:
    
    width in pixels
  - setLineWidth
```
public void setLineWidth(double lineWidth)
```
  - 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
  - doAutorange
```
public static QDataSet doAutorange(QDataSet tds)
```
  - render
```
public void render(java.awt.Graphics g1,
                   DasAxis xAxis,
                   DasAxis yAxis,
                   ProgressMonitor mon)
```
    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
    
    mon - a monitor for the operation. Note the render operation should be fast (<300ms).
  - 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)
```

Class PolarPlotRenderer

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

PROP_LINEWIDTH

PROP_ORIGINNORTH

originNorth

PROP_CLOCKWISE

PROP_ORIGIN

origin

PROP_DRAWPOLARAXES

mirror

PROP_MIRROR

Constructor Detail

PolarPlotRenderer

Method Detail

getListIcon

acceptContext

selectionArea

acceptsData

setColorBar

update

getLineWidth

setLineWidth

getColor

setColor

doAutorange

render

installRenderer

uninstallRenderer

getControl

setControl

isOriginNorth

setOriginNorth

isClockwise

setClockwise

getOrigin

setOrigin

isDrawPolarAxes

setDrawPolarAxes

isMirror

setMirror