net.talvi.puffinplot.plots

Class EqualAreaPlot

java.lang.Object

net.talvi.puffinplot.plots.Plot

net.talvi.puffinplot.plots.EqualAreaPlot

Direct Known Subclasses:

AmsPlot, SampleEqualAreaPlot, SeparateSuiteEqualAreaPlot, SiteEqualAreaPlot, SuiteEqualAreaPlot

public abstract class EqualAreaPlot
extends Plot

An abstract superclass for Lambert azimuthal equal-area plots. It provides various facilities to simplify the drawing of an equal-area plot, including projection of the data points and drawing of the axes.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Graphics2D	cachedGraphics The graphics object to which the plot is currently being drawn.
protected int	radius The radius of the projection.
protected int	xo The x co-ordinate of the projection's origin.
protected int	yo The y co-ordinate of the projection's origin.

Fields inherited from class net.talvi.puffinplot.plots.Plot

DEFAULT_PLOT_POSITIONS, dimensions, params, PLOT_POINT_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EqualAreaPlot(PlotParams parameters) Creates a new equal-area plot with the supplies parameters.

Method Summary

Modifier and Type	Method and Description
protected void	drawAxes() Draws the axes of the plot.
protected void	drawGreatCircle(Vec3 pole, boolean drawPole) Projects and draws a great circle
protected void	drawGreatCircleSegment(Vec3 v0, Vec3 v1) Draws the projection of a specified great-circle segment.
protected void	drawGreatCircleSegment(Vec3 v0, Vec3 v1, Vec3 dir) Draws the projection of a specified great-circle segment.
protected void	drawLineSegments(java.util.List<Vec3> vs) Projects and draws the supplied vectors.
abstract java.lang.String	getShortName() Returns a short, human-readable name for this plot.
protected java.awt.geom.Point2D.Double	project(Vec3 v) Projects the direction of a three-dimensional vector into plot co-ordinates.
protected LineCache	projectGreatCircleSegment(Vec3 v0, Vec3 v1) Create a projection of a great-circle segment.
protected void	projectLineSegments(java.util.List<Vec3> vs, LineCache cache) Project and cache line segments.
protected void	updatePlotDimensions(java.awt.Graphics2D g) Sets the fields cachedGraphics, radius, xo, and yo according to the supplied argument and the current plot dimensions.
protected java.awt.geom.Path2D.Double	vectorsToPath(java.util.List<Vec3> vectors) Projects a list of three-dimensional vectors into a two-dimensional path in the current plot co-ordinates.

Methods inherited from class net.talvi.puffinplot.plots.Plot

addPoint, addSampleClickListener, addVisibilityChangedListener, applyTextAttributes, areTreatmentStepsLabelled, clearPoints, cropRectangle, draw, drawPoints, getDashedStroke, getDimensions, getDimensionsAsString, getFontSize, getMargin, getName, getNiceName, getStroke, getTextAttributes, getTickLength, getTreatmentStepForPosition, getUnitSize, isVisible, mouseClicked, putText, putText, removeSampleClickListener, removeVisibilityChangedListener, selectByRectangle, setDimensions, setDimensionsToDefault, setVisible, timesTenToThe, timesTenToThe, writeString, writeString

Methods inherited from class java.lang.Object

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

Field Detail

cachedGraphics

protected java.awt.Graphics2D cachedGraphics

The graphics object to which the plot is currently being drawn. It is set by updatePlotDimensions(Graphics2D) at the start of the drawing process, and is then available as a convenience to both EqualAreaPlot and its subclasses, as an alternative to explicitly passing the current Graphics object around.

xo

protected int xo

The x co-ordinate of the projection's origin. It is set by updatePlotDimensions(Graphics2D).

yo

protected int yo

The y co-ordinate of the projection's origin. It is set by updatePlotDimensions(Graphics2D).

radius

protected int radius

The radius of the projection. It is set by updatePlotDimensions(Graphics2D).

Constructor Detail

EqualAreaPlot

protected EqualAreaPlot(PlotParams parameters)

Creates a new equal-area plot with the supplies parameters.

Parameters:

parameters - the plot parameters

Method Detail

updatePlotDimensions

protected void updatePlotDimensions(java.awt.Graphics2D g)

Sets the fields cachedGraphics, radius, xo, and yo according to the supplied argument and the current plot dimensions. This method should be called before redrawing the plot.

Parameters:

g - the field cachedGraphics will be set to this value

drawAxes

protected void drawAxes()

Draws the axes of the plot.

vectorsToPath

protected java.awt.geom.Path2D.Double vectorsToPath(java.util.List<Vec3> vectors)

Projects a list of three-dimensional vectors into a two-dimensional path in the current plot co-ordinates.

Parameters:

vectors - the vectors to project

Returns:

a path containing the projected vectors

projectLineSegments

protected void projectLineSegments(java.util.List<Vec3> vs,
                                   LineCache cache)

Project and cache line segments. Assumes all segments in same hemisphere.

Parameters:

vs - vectors to project

cache - line cache in which to store projected vector path

drawLineSegments

protected void drawLineSegments(java.util.List<Vec3> vs)

Projects and draws the supplied vectors.

Parameters:

vs - the vectors to draw

projectGreatCircleSegment

protected LineCache projectGreatCircleSegment(Vec3 v0,
                                              Vec3 v1)

Create a projection of a great-circle segment.

Parameters:

v0 - first endpoint of the great-circle segment

v1 - second endpoint of the great-circle segment

Returns:

line segments corresponding to a projection of the segment

drawGreatCircleSegment

protected void drawGreatCircleSegment(Vec3 v0,
                                      Vec3 v1)

Draws the projection of a specified great-circle segment. The shorter of the two possible paths will be drawn.

Parameters:

v0 - one end of a great-circle segment

v1 - the other end of a great-circle segment

drawGreatCircleSegment

protected void drawGreatCircleSegment(Vec3 v0,
                                      Vec3 v1,
                                      Vec3 dir)

Draws the projection of a specified great-circle segment. Of the two possible paths, the one passing closer to the supplied vector dir will be drawn.

Parameters:

v0 - one end of a great-circle segment

v1 - the other end of a great-circle segment

dir - vector used to choose which path to draw

drawGreatCircle

protected void drawGreatCircle(Vec3 pole,
                               boolean drawPole)

Projects and draws a great circle

Parameters:

pole - the pole to the great circle which is to be drawn

drawPole - true to mark the pole on the plot

project

protected java.awt.geom.Point2D.Double project(Vec3 v)

Projects the direction of a three-dimensional vector into plot co-ordinates. The supplied vector must be well-formed (i.e. its components must be finite numbers rather than NaN or infinite values).

Parameters:

v - a well-formed vector

Returns:

the projection of the supplied vector onto this plot

getShortName

public abstract java.lang.String getShortName()

Returns a short, human-readable name for this plot. This is used to label the plots on the graph display during normal use. (The "nice name" is used when resizing/moving.)

Returns:

a short, human-readable name for this plot