Plotter<GridPlotter.GridStyle>
public class GridPlotter extends java.lang.Object implements Plotter<GridPlotter.GridStyle>
Modifier and Type | Class | Description |
---|---|---|
static class |
GridPlotter.GridStyle |
Style for configuring the grid plot.
|
Modifier and Type | Field | Description |
---|---|---|
static ConfigKey<java.lang.Double> |
TRANSPARENCY_KEY |
|
static ConfigKey<BinSizer> |
XBINSIZER_KEY |
Config key for X bin size configuration.
|
static ReportKey<java.lang.Double> |
XBINWIDTH_KEY |
ReportKey for actual X bin extent.
|
static ConfigKey<java.lang.Double> |
XPHASE_KEY |
Config key for X bin phase.
|
static ConfigKey<BinSizer> |
YBINSIZER_KEY |
Config key for Y bin size configuration.
|
static ReportKey<java.lang.Double> |
YBINWIDTH_KEY |
ReportKey for actual Y bin extent.
|
static ConfigKey<java.lang.Double> |
YPHASE_KEY |
Config key for Y bin phase.
|
Constructor | Description |
---|---|
GridPlotter(boolean transparent) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
PlotLayer |
createLayer(DataGeom geom,
DataSpec dataSpec,
GridPlotter.GridStyle style) |
Creates a PlotLayer based on the given geometry, data and style.
|
GridPlotter.GridStyle |
createStyle(ConfigMap config) |
Creates a style that can be used when creating a plot layer.
|
CoordGroup |
getCoordGroup() |
Returns an object describing which data coordinates are used for
this plotter and how they are arranged in supplied DataSpec objects.
|
java.lang.String |
getPlotterDescription() |
Returns an XML description of this plotter.
|
javax.swing.Icon |
getPlotterIcon() |
Returns an icon for this plotter for use in user interface.
|
java.lang.String |
getPlotterName() |
Returns the name of this plotter for use in user interface.
|
ConfigKey[] |
getStyleKeys() |
Returns the configuration keys used to configure style for this plotter.
|
boolean |
hasReports() |
Indicates whether the drawings produced by this plotter will
return general interest report information to upstream plotting code.
|
public static final ReportKey<java.lang.Double> XBINWIDTH_KEY
public static final ReportKey<java.lang.Double> YBINWIDTH_KEY
public static final ConfigKey<BinSizer> XBINSIZER_KEY
public static final ConfigKey<BinSizer> YBINSIZER_KEY
public static final ConfigKey<java.lang.Double> XPHASE_KEY
public static final ConfigKey<java.lang.Double> YPHASE_KEY
public static final ConfigKey<java.lang.Double> TRANSPARENCY_KEY
public GridPlotter(boolean transparent)
transparent
- if true, there will be a config option for
setting the alpha value of the whole layerpublic java.lang.String getPlotterName()
Plotter
getPlotterName
in interface Plotter<GridPlotter.GridStyle>
public javax.swing.Icon getPlotterIcon()
Plotter
getPlotterIcon
in interface Plotter<GridPlotter.GridStyle>
public CoordGroup getCoordGroup()
Plotter
getCoordGroup
in interface Plotter<GridPlotter.GridStyle>
public boolean hasReports()
Plotter
hasReports
in interface Plotter<GridPlotter.GridStyle>
Drawing.getReport(java.lang.Object)
public java.lang.String getPlotterDescription()
Plotter
Note: really this should appear at the LayerType level.
getPlotterDescription
in interface Plotter<GridPlotter.GridStyle>
public ConfigKey[] getStyleKeys()
Plotter
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.getStyleKeys
in interface Plotter<GridPlotter.GridStyle>
public GridPlotter.GridStyle createStyle(ConfigMap config)
Plotter
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)
.createStyle
in interface Plotter<GridPlotter.GridStyle>
config
- map of style configuration itemspublic PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, GridPlotter.GridStyle style)
Plotter
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
getCoordGroup()
.
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.
createLayer
in interface Plotter<GridPlotter.GridStyle>
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 truedataSpec
- specifies the data required for the plotstyle
- data style as obtained from createStyle
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.