uk.ac.starlink.ttools.plot2.layer

Class HealpixPlotter

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<HealpixPlotter.HealpixStyle>

uk.ac.starlink.ttools.plot2.layer.HealpixPlotter

All Implemented Interfaces:

Plotter<HealpixPlotter.HealpixStyle>

public class HealpixPlotter
extends AbstractPlotter<HealpixPlotter.HealpixStyle>

Plotter for plotting lists of HEALPix tiles.

Since:

31 Mar 2016

Author:

Mark Taylor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealpixPlotter.HealpixStyle Style for configuring the HEALPix plot.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<SolidAngleUnit>	ANGLE_KEY Config key for scaling angle unit.
static ConfigKey<Combiner>	COMBINER_KEY Config key for degrade combination mode.
static ConfigKey<Integer>	DATALEVEL_KEY ConfigKey for HEALPix level corresponding to data HEALPix indices.
static ConfigKey<SkySys>	DATASYS_KEY ConfigKey for Sky System corresponding to data HEALPix indices.
static ConfigKey<Integer>	DEGRADE_KEY Config key for HEALPix level degradation.
static boolean	IS_NEST Currently always works with HEALPix NESTED scheme.
static int	MAX_LEVEL Maximum HEALPix level supported by this plotter.
static FloatingCoord	VALUE_COORD Coordinate for value determining tile colours.

Constructor Summary

Constructors

Constructor and Description
HealpixPlotter(boolean transparent) Constructor.

Method Summary

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

IS_NEST

public static final boolean IS_NEST

Currently always works with HEALPix NESTED scheme.

See Also:

Constant Field Values

MAX_LEVEL

public static final int MAX_LEVEL

Maximum HEALPix level supported by this plotter.

See Also:

Constant Field Values

VALUE_COORD

public static final FloatingCoord VALUE_COORD

Coordinate for value determining tile colours.

DATALEVEL_KEY

public static final ConfigKey<Integer> DATALEVEL_KEY

ConfigKey for HEALPix level corresponding to data HEALPix indices.

DATASYS_KEY

public static final ConfigKey<SkySys> DATASYS_KEY

ConfigKey for Sky System corresponding to data HEALPix indices.

ANGLE_KEY

public static final ConfigKey<SolidAngleUnit> ANGLE_KEY

Config key for scaling angle unit.

DEGRADE_KEY

public static final ConfigKey<Integer> DEGRADE_KEY

Config key for HEALPix level degradation.

COMBINER_KEY

public static final ConfigKey<Combiner> COMBINER_KEY

Config key for degrade combination mode.

Constructor Detail

HealpixPlotter

public HealpixPlotter(boolean transparent)

Constructor.

Parameters:

transparent - if true, there will be a config option for setting the alpha value of the whole layer

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 HealpixPlotter.HealpixStyle 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,
                             HealpixPlotter.HealpixStyle 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