uk.ac.starlink.ttools.plot2.layer
Class PairPlotter

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<PairPlotter.PairStyle>
      extended by uk.ac.starlink.ttools.plot2.layer.PairPlotter
All Implemented Interfaces:
Plotter<PairPlotter.PairStyle>

public class PairPlotter
extends AbstractPlotter<PairPlotter.PairStyle>

Plots a pair of related points.

Since:
25 Nov 2013
Author:
Mark Taylor

Nested Class Summary
static class PairPlotter.PairStyle
          Style class for pair plots.
 
Constructor Summary
PairPlotter()
          Constructor.
 
Method Summary
 PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, PairPlotter.PairStyle style)
          Creates a PlotLayer based on the given geometry, data and style.
 PairPlotter.PairStyle createStyle(ConfigMap config)
          Creates a style that can be used when creating a plot layer.
 ConfigKey[] getStyleKeys()
          Returns the configuration keys used to configure style for this plotter.
 
Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractPlotter
getExtraCoords, getPlotterIcon, getPlotterName, getPositionCount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PairPlotter

public PairPlotter()
Constructor.

Method Detail

getStyleKeys

public ConfigKey[] getStyleKeys()
Description copied from interface: Plotter
Returns the configuration keys used to configure style for this plotter. The keys in the return value are used in the map supplied to the Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.

Returns:
keys used when creating a style for this plotter.

createStyle

public PairPlotter.PairStyle createStyle(ConfigMap config)
Description copied from interface: Plotter
Creates a style that can be used when creating a plot layer. The keys that are significant in the supplied config map are those returned by Plotter.getStyleKeys(). The return value can be used as input to Plotter.createLayer(uk.ac.starlink.ttools.plot2.DataGeom, uk.ac.starlink.ttools.plot2.data.DataSpec, S).

Parameters:
config - map of style configuration items
Returns:
plotter-specific plot style

createLayer

public PlotLayer createLayer(DataGeom geom,
                             DataSpec dataSpec,
                             PairPlotter.PairStyle style)
Description copied from interface: Plotter
Creates a PlotLayer based on the given geometry, data and style.

The style parameter is the result of a call to Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap).

The dataSpec parameter must contain the coordinates defined by this plotter. That is, getPositionCount} groups of the coordinates given by dataGeom.getPosCoords, followed by the coordinates given by getExtraCoords.

The pointDataGeom parameter is only used if Plotter.getPositionCount() returns a non-zero value, otherwise the plot does not have point positions.

It is legal to supply null for any of the parameters; if insufficient data is supplied to generate a plot, then the method should return null.

Creating a layer should be cheap; layers may be created and not used.

Parameters:
geom - indicates base position coordinates and their mapping to points in the data space; if non-null, the data geom's DataGeom.hasPosition() method will return true
dataSpec - specifies the data required for the plot
style - data style as obtained from createStyle
Returns:
new plot layer, or null if no drawing will take place


Copyright © 2013 Central Laboratory of the Research Councils. All Rights Reserved.