uk.ac.starlink.ttools.plot2.layer

Class SphereGridPlotter

java.lang.Object

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

uk.ac.starlink.ttools.plot2.layer.SphereGridPlotter

All Implemented Interfaces:

Plotter<SphereGridPlotter.GridStyle>

public class SphereGridPlotter
extends AbstractPlotter<SphereGridPlotter.GridStyle>

Plotter that can draw a spherical grid around the origin of a CubeSurface.

Since:

15 Aug 2018

Author:

Mark Taylor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SphereGridPlotter.GridStyle Style class for sphere grid plotter.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<Color>	COLOR_KEY Config key for grid line colour.
static ConfigKey<Integer>	NLAT_KEY Config key determining number of latitude lines drawn.
static ConfigKey<Integer>	NLON_KEY Config key for number of longitude lines drawn.
static ConfigKey<Double>	RADIUS_KEY Config key for sphere radius.
static ConfigKey<Integer>	THICK_KEY Config key for grid line thickness.

Constructor Summary

Constructors

Constructor and Description
SphereGridPlotter() Constructor.

Method Summary

Modifier and Type	Method and Description
PlotLayer	createLayer(DataGeom geom, DataSpec dataSpec, SphereGridPlotter.GridStyle style) Creates a PlotLayer based on the given geometry, data and style.
SphereGridPlotter.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.

THICK_KEY

public static final ConfigKey<Integer> THICK_KEY

Config key for grid line thickness.

RADIUS_KEY

public static final ConfigKey<Double> RADIUS_KEY

Config key for sphere radius.

NLON_KEY

public static final ConfigKey<Integer> NLON_KEY

Config key for number of longitude lines drawn.

NLAT_KEY

public static final ConfigKey<Integer> NLAT_KEY

Config key determining number of latitude lines drawn.

Constructor Detail

SphereGridPlotter

public SphereGridPlotter()

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 SphereGridPlotter.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,
                             SphereGridPlotter.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