Package detectionPlotFX.layout

Interface DetectionPlot<D>

Type Parameters:

D - - the type of data that is input for plotting

All Known Implementing Classes:

CTSpectrumPlot, CTWaveformPlot, FFTPlot, IshFFTPlot, MTClassifierPane.RawDataPlot, MTClassifierPane.WignerTemplateData, OverlayGroupDisplay.RawWaveFFTPlot, RawFFTPlot, RawHolderFFTPlot, RawSpectrumPlot, RawWaveformPlot, RawWignerPlot, SpectrumPlot, TemplateSpectrumPane.SpectrumTemplatePlot, WaterfallSpecPlot, WaveformPlot, WhistleFFTPlot, WhistleWignerPlot, WignerPlot

public interface DetectionPlot<D>

An interface to satisfy basic plots. Note that this does not have to be used in a DetectionDisplay

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SCROLLPANE_DRAW	Indicates that the data unit is being drawn on a scroll bar.
static final int	STANDARD_DRAW	Indicates that the data unit is being drawn on the plot canvas.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name of the plot e.g.
javafx.scene.layout.Pane	getSettingsPane()	Get the settings pane for the particular plot.
void	paintPlot(D data, javafx.scene.canvas.GraphicsContext graphicsContext, javafx.scene.shape.Rectangle rectangle, DetectionPlotProjector projector, int flag)	Plot the relevent data from a detection.
void	setupAxis(D data, double sR, DetectionPlotProjector projector)	Setup the axis.
void	setupPlot()	Setup the plot.

Field Details

STANDARD_DRAW

static final int STANDARD_DRAW

Indicates that the data unit is being drawn on the plot canvas.

See Also:

• Constant Field Values

SCROLLPANE_DRAW

static final int SCROLLPANE_DRAW

Indicates that the data unit is being drawn on a scroll bar.

See Also:

• Constant Field Values

Method Details

getName

String getName()

Get the name of the plot e.g. waveform, spectrum etc.

setupPlot

void setupPlot()

Setup the plot. This may, for example, involve changing axis etc.

Parameters:

detectionPlotDisplay - : The detection display.

setupAxis

void setupAxis(D data,
 double sR,
 DetectionPlotProjector projector)

Setup the axis. This is called before paintPlot. Ensures axis are correct values

Parameters:

data - - the data of every channel. e.g. might be a waveform with each point representing a sample.

sR - - the sample rate. Primarily used to convert bins into time values.

pamAxis - - all the axis of the graph. This is in order TOP, RIGHT, BOTTOM, LEFT.

paintPlot

void paintPlot(D data,
 javafx.scene.canvas.GraphicsContext graphicsContext,
 javafx.scene.shape.Rectangle rectangle,
 DetectionPlotProjector projector,
 int flag)

Plot the relevent data from a detection.

Parameters:

data - - the data of every channel. e.g. might be a waveform with each point representing a sample.

graphicsContext - - the graphics handle to draw on.

pamAxis - - the PamAxis for the plot, x and y axis (time and some measure of amplitude. )

a - flag with extra information - e.g. if this is a scroll bar paint or not.

getSettingsPane

javafx.scene.layout.Pane getSettingsPane()

Get the settings pane for the particular plot. This sits on the right hand side of the display inside a hiding pane.

Returns:

a pane with controls for changing settings in a node.