Package dataPlotsFX.whistlePlotFX
Class WhistlePlotInfoFX
java.lang.Object
dataPlotsFX.data.TDDataInfoFX
dataPlotsFX.whistlePlotFX.WhistlePlotInfoFX
Whistles/Moans are long (relatively) tonal sounds which can be plotted on a bearing/amplitude display and/or spectrogram.
- Author:
- Jamie Macaulay.
-
Nested Class Summary
Nested classes/interfaces inherited from class dataPlotsFX.data.TDDataInfoFX
TDDataInfoFX.DataLoadObserver
-
Field Summary
Fields inherited from class dataPlotsFX.data.TDDataInfoFX
dataPlugIns, scaleInfoIndex
-
Constructor Summary
ConstructorDescriptionWhistlePlotInfoFX
(TDDataProviderFX tdDataProvider, WhistleMoanControl wmControl, TDGraphFX tdGraph, ConnectedRegionDataBlock pamDataBlock) -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.shape.Polygon
drawDataUnit
(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Draw a data unit.static Path2D
drawWhistleFragement
(PamDataUnit pamDataUnit, WhistleMoanControl wmControl, int fftLength, int fftHop, float sampleRate, javafx.scene.canvas.GraphicsContext g, TimeProjectorFX tdprojector, double scrollStart, int type, javafx.scene.paint.Color fillCol, javafx.scene.paint.Color linCol, boolean useKhz, javafx.geometry.Orientation orientation) Draw a whistle fragment.static Path2D
drawWhistleFragement
(PamDataUnit pamDataUnit, WhistleMoanControl wmControl, int fftLength, int fftHop, float sampleRate, javafx.scene.canvas.GraphicsContext g, TimeProjectorFX tdprojector, double scrollStart, int type, javafx.scene.paint.Color fillCol, javafx.scene.paint.Color linCol, javafx.geometry.Orientation orientation) Draw a whistle fragment.getDataValue
(PamDataUnit pamDataUnit) Gets a value for a specific data unit which should be in the same units as the scale information.getDDataProvider
(DetectionPlotDisplay detectionDisplay) The detection display data info provider.Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.Get the source data block.Get the whistle symbol chooser.Get the whistle and moan control.Methods inherited from class dataPlotsFX.data.TDDataInfoFX
addScaleInfo, clearDraw, drawAllDataUnits, drawData, drawHighLightData, editOptions, getCurrentScaleInfo, getDataBlock, getDataDimensions, getDataName, getDataObserver, getDataProvider, getDisplayColType, getLastDrawPoints, getMasterClockOverride, getMenuNodes, getPreviousDataUnit, getRequiredDataHistory, getScaleInfo, getScaleInfoIndex, getScaleInfos, getShortName, getStoredSettings, getTDGraph, getToolTipText, hasAxisName, hasOptions, isPaused, isScrollChanging, isShowing, isViewer, lastUnitDrawn, notifyChange, removeData, removeScaleInfo, selectScaleInfo, setCurrentAxisName, setNPlotPanes, setShowing, setStoredSettings, shouldDraw, shouldDraw, timeRangeSpinnerChange, timeScrollRangeChanged, timeScrollValueChanged
-
Constructor Details
-
WhistlePlotInfoFX
public WhistlePlotInfoFX(TDDataProviderFX tdDataProvider, WhistleMoanControl wmControl, TDGraphFX tdGraph, ConnectedRegionDataBlock pamDataBlock)
-
-
Method Details
-
getDataValue
Description copied from class:TDDataInfoFX
Gets a value for a specific data unit which should be in the same units as the scale information. This will then be converted into a plot position by the TDGraph.- Specified by:
getDataValue
in classTDDataInfoFX
- Returns:
- data value or null if this data point should not be plotted.
-
getScaleInfo
- Overrides:
getScaleInfo
in classTDDataInfoFX
- Returns:
- the fixedScaleInformation
-
drawDataUnit
public javafx.scene.shape.Polygon drawDataUnit(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Description copied from class:TDDataInfoFX
Draw a data unit.- Overrides:
drawDataUnit
in classTDDataInfoFX
- Parameters:
pamDataUnit
- data unit to drawg
- graphicsContext handle to draw ontype
- flag for which type of symbol to draw. e.g normal or highlighted.- Returns:
- polygon of area drawn on.
-
drawWhistleFragement
public static Path2D drawWhistleFragement(PamDataUnit pamDataUnit, WhistleMoanControl wmControl, int fftLength, int fftHop, float sampleRate, javafx.scene.canvas.GraphicsContext g, TimeProjectorFX tdprojector, double scrollStart, int type, javafx.scene.paint.Color fillCol, javafx.scene.paint.Color linCol, javafx.geometry.Orientation orientation) Draw a whistle fragment.- Parameters:
pamDataUnit
- - the PAM data unitwmControl
-fftLength
- - the FFT length in samplesfftHop
- - the FFT hop in samplessampleRate
- - the sample rate in samples per secondg
- - the graphics handletdprojector
- - projector which converts pixels to time, frequency and vice versa.scrollStart
- - the scroll starttype
- - type flag for plottingfillCol
- - the fill colourlinCol
- - the line colour.orientation
- - orientationwindowRect
- - window describing window pixel dimensions to draw onuseKhz
- - true to pot with kHz instead of Hz- Returns:
- a 2D path in pixels of the fragment.
-
drawWhistleFragement
public static Path2D drawWhistleFragement(PamDataUnit pamDataUnit, WhistleMoanControl wmControl, int fftLength, int fftHop, float sampleRate, javafx.scene.canvas.GraphicsContext g, TimeProjectorFX tdprojector, double scrollStart, int type, javafx.scene.paint.Color fillCol, javafx.scene.paint.Color linCol, boolean useKhz, javafx.geometry.Orientation orientation) Draw a whistle fragment.- Parameters:
pamDataUnit
- - the PAM data unitwmControl
-fftLength
- - the FFT length in samplesfftHop
- - the FFT hop in samplessampleRate
- - the sample rate in samples per secondg
- - the graphics handletdprojector
- - projector which converts pixels to time, frequency and vice versa.scrollStart
- - the scroll starttype
- - type flag for plottingfillCol
- - the fill colourlinCol
- - the line colour.useKhz
- - true to pot with kHz instead of Hzorientation
- - orientationwindowRect
- - window describing window pixel dimensions to draw on- Returns:
- a 2D path in pixels of the fragment.
-
getSymbolChooser
- Specified by:
getSymbolChooser
in classTDDataInfoFX
- Returns:
- a class containing functions to chose a symbol to plot.
-
getWmControl
Get the whistle and moan control.- Returns:
- the whistle and moan control.
-
getSourceDataBlock
Description copied from class:TDDataInfoFX
Get the source data block.
Generally the source data block is used in viewer mode to load data. e.g. FFT uses raw sound acquisition for source data block. The source data block can cause issues e.g. the whistle and moan contours use noise free FFT data as a source data block. Thus if this function is is not overridden in WhistlePlotInfo then raw FFT data will be saved, something which uses large amounts of memory.- Overrides:
getSourceDataBlock
in classTDDataInfoFX
- Returns:
- the source data block.
- See Also:
-
-
invalid @see
WhistlePlotInfo
-
-
getGraphSettingsPane
Description copied from class:TDDataInfoFX
Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.- Overrides:
getGraphSettingsPane
in classTDDataInfoFX
- Returns:
- sliding dialog component.
-
getWhistleSymbolChooser
Get the whistle symbol chooser.- Returns:
- the whistle symbol chooser.
-
getDDataProvider
The detection display data info provider. This allows detection to be plotted in right click panes- Overrides:
getDDataProvider
in classTDDataInfoFX
- Returns:
- the data info for the detection type./
-