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>
Plotter for plotting lists of HEALPix tiles.
- Since:
- 31 Mar 2016
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Style for configuring the HEALPix plot. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ConfigKey
<SolidAngleUnit> Config key for scaling angle unit.Config key for degrade combination mode.ConfigKey for HEALPix level corresponding to data HEALPix indices.ConfigKey for Sky System corresponding to data HEALPix indices.Config key for HEALPix level degradation.static final boolean
Currently always works with HEALPix NESTED scheme.static final int
Maximum HEALPix level supported by this plotter.static final FloatingCoord
Coordinate for value determining tile colours. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateLayer
(DataGeom geom, DataSpec dataSpec, HealpixPlotter.HealpixStyle style) Creates a PlotLayer based on the given geometry, data and style.createStyle
(ConfigMap config) Creates a style that can be used when creating a plot layer.Returns an XML description of this plotter.ConfigKey<?>[]
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
-
Field Details
-
IS_NEST
public static final boolean IS_NESTCurrently always works with HEALPix NESTED scheme.- See Also:
-
MAX_LEVEL
public static final int MAX_LEVELMaximum HEALPix level supported by this plotter.- See Also:
-
VALUE_COORD
Coordinate for value determining tile colours. -
DATALEVEL_KEY
ConfigKey for HEALPix level corresponding to data HEALPix indices. -
DATASYS_KEY
ConfigKey for Sky System corresponding to data HEALPix indices. -
ANGLE_KEY
Config key for scaling angle unit. -
DEGRADE_KEY
Config key for HEALPix level degradation. -
COMBINER_KEY
Config key for degrade combination mode.
-
-
Constructor Details
-
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 Details
-
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
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 thePlotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.- Returns:
- keys used when creating a style for this plotter.
-
createStyle
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 byPlotter.getStyleKeys()
. The return value can be used as input toPlotter.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
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 toPlotter.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 theCoordGroup.getBasicPositionCount()
orCoordGroup.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 spacedataSpec
- specifies the data required for the plotstyle
- data style as obtained fromcreateStyle
- Returns:
- new plot layer, or null if no drawing will take place
-