Class GridPlotter
- All Implemented Interfaces:
Plotter<GridPlotter.GridStyle>
- Since:
- 13 Jan 2017
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Style for configuring the grid plot. -
Field Summary
FieldsModifier and TypeFieldDescriptionConfig key for combination mode.static final ReportKey<uk.ac.starlink.table.StarTable>
ReportKey for exported grid table.Config key for X bin size configuration.ReportKey for actual X bin extent.Config key for X bin phase.Config key for Y bin size configuration.ReportKey for actual Y bin extent.Config key for Y bin phase. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateLayer
(DataGeom geom, DataSpec dataSpec, GridPlotter.GridStyle 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 object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.Returns an XML description of this plotter.Returns an icon for this plotter for use in user interface.Returns the name of this plotter for use in user interface.Returns an opaque object characterising the region of the plot surface covered when using a given plotter style.ConfigKey<?>[]
Returns the configuration keys used to configure style for this plotter.boolean
Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.
-
Field Details
-
XBINWIDTH_KEY
ReportKey for actual X bin extent. -
YBINWIDTH_KEY
ReportKey for actual Y bin extent. -
GRIDTABLE_KEY
ReportKey for exported grid table. -
XBINSIZER_KEY
Config key for X bin size configuration. -
YBINSIZER_KEY
Config key for Y bin size configuration. -
XPHASE_KEY
Config key for X bin phase. -
YPHASE_KEY
Config key for Y bin phase. -
COMBINER_KEY
Config key for combination mode. -
TRANSPARENCY_KEY
-
-
Constructor Details
-
GridPlotter
public GridPlotter(boolean transparent) Constructor.- Parameters:
transparent
- if true, there will be a config option for setting the alpha value of the whole layer
-
-
Method Details
-
getPlotterName
Description copied from interface:Plotter
Returns the name of this plotter for use in user interface.- Specified by:
getPlotterName
in interfacePlotter<GridPlotter.GridStyle>
- Returns:
- user-directed plotter name
-
getPlotterIcon
Description copied from interface:Plotter
Returns an icon for this plotter for use in user interface.- Specified by:
getPlotterIcon
in interfacePlotter<GridPlotter.GridStyle>
- Returns:
- plotter icon
-
getCoordGroup
Description copied from interface:Plotter
Returns an object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.- Specified by:
getCoordGroup
in interfacePlotter<GridPlotter.GridStyle>
- Returns:
- coordinate group
-
hasReports
public boolean hasReports()Description copied from interface:Plotter
Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.- Specified by:
hasReports
in interfacePlotter<GridPlotter.GridStyle>
- Returns:
- true if the plot report may return interesting information
- See Also:
-
getPlotterDescription
Description copied from interface:Plotter
Returns an XML description of this plotter.Note: really this should appear at the LayerType level.
- Specified by:
getPlotterDescription
in interfacePlotter<GridPlotter.GridStyle>
- 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.- Specified by:
getStyleKeys
in interfacePlotter<GridPlotter.GridStyle>
- 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)
.- Specified by:
createStyle
in interfacePlotter<GridPlotter.GridStyle>
- Parameters:
config
- map of style configuration items- Returns:
- plotter-specific plot style
-
getRangeStyleKey
Description copied from interface:Plotter
Returns an opaque object characterising the region of the plot surface covered when using a given plotter style. If this object changes between layers produced by this plotter, it provides a hint that it may be necessary to redetermine the axis ranges (usingextendCoordinateRanges
).In many cases, such as scatter-plot-like plotters, the range is determined only by the coordinate data (managed by
DataSpec
inputs) so a null value may be returned. This method is chiefly required by histogram-like plotters for which the region on the plot surface is not the union of the input positions.- Specified by:
getRangeStyleKey
in interfacePlotter<GridPlotter.GridStyle>
- Parameters:
style
- plot style to assess- Returns:
- opaque object with equality semantics, or null if axis range is not a function of 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.
- Specified by:
createLayer
in interfacePlotter<GridPlotter.GridStyle>
- 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
-