public class FunctionPlotter extends AbstractPlotter<FunctionPlotter.FunctionStyle>
FunctionPlotter.FuncAxis
interface,
which in principle allows functions of any geometric variable
to be specified.Modifier and Type | Class and Description |
---|---|
static interface |
FunctionPlotter.FuncAxis
Defines the geometric role of the dependent and independent variables
for a function.
|
static class |
FunctionPlotter.FunctionStyle
Style class associated with this plotter.
|
Modifier and Type | Field and Description |
---|---|
static FunctionPlotter |
PLANE
FunctionPlotter instance for a 2-d plotting surface.
|
Constructor and Description |
---|
FunctionPlotter(FunctionPlotter.FuncAxis[] axes)
Constructs a plotter with a given set of axis geometry options.
|
Modifier and Type | Method and Description |
---|---|
PlotLayer |
createLayer(DataGeom geom,
DataSpec dataSpec,
FunctionPlotter.FunctionStyle style)
Creates a PlotLayer based on the given geometry, data and style.
|
FunctionPlotter.FunctionStyle |
createStyle(ConfigMap config)
Creates a style that can be used when creating a plot layer.
|
ConfigKey[] |
getFunctionStyleKeys()
Returns the subset of the style keys which defines the function
itself.
|
java.lang.String |
getPlotterDescription()
Returns an XML description of this plotter.
|
ConfigKey[] |
getStyleKeys()
Returns the configuration keys used to configure style for this plotter.
|
getCoordGroup, getPlotterIcon, getPlotterName, hasReports
public static final FunctionPlotter PLANE
public FunctionPlotter(FunctionPlotter.FuncAxis[] axes)
axes
- options for function variable definitionspublic java.lang.String getPlotterDescription()
Plotter
Note: really this should appear at the LayerType level.
public ConfigKey[] getStyleKeys()
Plotter
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.public ConfigKey[] getFunctionStyleKeys()
public FunctionPlotter.FunctionStyle createStyle(ConfigMap config) throws ConfigException
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)
.config
- map of style configuration itemsConfigException
public PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, FunctionPlotter.FunctionStyle 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.
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 © 2017 Central Laboratory of the Research Councils. All Rights Reserved.