uk.ac.starlink.ttools.plot2.layer

Class SkyGridPlotter

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<SkyGridPlotter.GridStyle>

uk.ac.starlink.ttools.plot2.layer.SkyGridPlotter

All Implemented Interfaces:

Plotter<SkyGridPlotter.GridStyle>

public class SkyGridPlotter
extends AbstractPlotter<SkyGridPlotter.GridStyle>

Plotter that can draw a sky axis grid on a sky surface. This can be for a different sky system than that defined by the sky surface itself.

Since:

10 Apr 2017

Author:

Mark Taylor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SkyGridPlotter.GridStyle Style for configuring the grid plot.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<Color>	COLOR_KEY Config key for grid line colour.
static ConfigKey<SkySys>	GRIDSYS_KEY Config key for grid sky system.
static ConfigKey<SkyAxisLabeller>	LABELLER_KEY Config key for grid label positioning.
static ConfigKey<Double>	LATCROWD_KEY Config key for latitude grid line crowding.
static ConfigKey<Double>	LONCROWD_KEY Config key for longitude grid line crowding.
static ConfigKey<Double>	TRANSPARENCY_KEY Config key for grid line transparency.

Constructor Summary

Constructors

Constructor and Description
SkyGridPlotter() Constructor.

Method Summary

Modifier and Type	Method and Description
PlotLayer	createLayer(DataGeom geom, DataSpec dataSpec, SkyGridPlotter.GridStyle style) Creates a PlotLayer based on the given geometry, data and style.
SkyGridPlotter.GridStyle	createStyle(ConfigMap config) Creates a style that can be used when creating a plot layer.
String	getPlotterDescription() Returns an XML description of this plotter.
ConfigKey<?>[]	getStyleKeys() Returns the configuration keys used to configure style for this plotter.

Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractPlotter

getCoordGroup, getPlotterIcon, getPlotterName, getRangeStyleKey, hasReports

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_KEY

public static final ConfigKey<Color> COLOR_KEY

Config key for grid line colour.

TRANSPARENCY_KEY

public static final ConfigKey<Double> TRANSPARENCY_KEY

Config key for grid line transparency.

LONCROWD_KEY

public static final ConfigKey<Double> LONCROWD_KEY

Config key for longitude grid line crowding.

LATCROWD_KEY

public static final ConfigKey<Double> LATCROWD_KEY

Config key for latitude grid line crowding.

GRIDSYS_KEY

public static final ConfigKey<SkySys> GRIDSYS_KEY

Config key for grid sky system.

LABELLER_KEY

public static final ConfigKey<SkyAxisLabeller> LABELLER_KEY

Config key for grid label positioning.

Constructor Detail

SkyGridPlotter

public SkyGridPlotter()

Constructor.

Method Detail

getPlotterDescription

public String getPlotterDescription()

Description copied from interface: Plotter

Returns an XML description of this plotter.

Note: really this should appear at the LayerType level.

Returns:

one or more <p> elements

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 SkyGridPlotter.GridStyle 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,
                             SkyGridPlotter.GridStyle 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's CoordGroup.

The pointDataGeom parameter is only used if the CoordGroup.getBasicPositionCount() or CoordGroup.getExtraPositionCount() method from this plotter's CoordGroup return 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

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