|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.layer.SpectrogramPlotter
public class SpectrogramPlotter
Plotter for spectrograms. A spectrogram is a spectrum represented as a vertical line of pixels at successive positions in a time series (time axis horizontal, spectral axis vertical).
Nested Class Summary | |
---|---|
static interface |
SpectrogramPlotter.ChannelGrid
Defines the spectrum frequency channels. |
static class |
SpectrogramPlotter.SpectroStyle
Style subclass for SpectrogramPlotter. |
Constructor Summary | |
---|---|
SpectrogramPlotter(FloatingCoord xCoord)
Constructor. |
Method Summary | |
---|---|
PlotLayer |
createLayer(DataGeom geom,
DataSpec dataSpec,
SpectrogramPlotter.SpectroStyle style)
The supplied geom is ignored. |
SpectrogramPlotter.SpectroStyle |
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. |
int |
getExtentCoordIndex()
Returns the coordinate index for the time extent coordinate. |
String |
getPlotterDescription()
Returns an XML description of this plotter. |
Icon |
getPlotterIcon()
Returns an icon for this plotter for use in user interface. |
String |
getPlotterName()
Returns the name of this plotter for use in user interface. |
int |
getSpectrumCoordIndex()
Returns the coordinate index for the spectral coordinate. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SpectrogramPlotter(FloatingCoord xCoord)
xCoord
- horizontal axis coordinateMethod Detail |
---|
public int getSpectrumCoordIndex()
public int getExtentCoordIndex()
public String getPlotterName()
Plotter
getPlotterName
in interface Plotter<SpectrogramPlotter.SpectroStyle>
public Icon getPlotterIcon()
Plotter
getPlotterIcon
in interface Plotter<SpectrogramPlotter.SpectroStyle>
public String getPlotterDescription()
Plotter
Note: really this should appear at the LayerType level.
getPlotterDescription
in interface Plotter<SpectrogramPlotter.SpectroStyle>
public CoordGroup getCoordGroup()
Plotter
getCoordGroup
in interface Plotter<SpectrogramPlotter.SpectroStyle>
public ConfigKey[] getStyleKeys()
Plotter
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.
getStyleKeys
in interface Plotter<SpectrogramPlotter.SpectroStyle>
public SpectrogramPlotter.SpectroStyle 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<SpectrogramPlotter.SpectroStyle>
config
- map of style configuration items
public boolean hasReports()
Plotter
hasReports
in interface Plotter<SpectrogramPlotter.SpectroStyle>
Drawing.getReport(java.lang.Object)
public PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, SpectrogramPlotter.SpectroStyle style)
geom
is ignored.
createLayer
in interface Plotter<SpectrogramPlotter.SpectroStyle>
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |