Class WhistlePlotInfoFX

java.lang.Object
dataPlotsFX.data.TDDataInfoFX
dataPlotsFX.whistlePlotFX.WhistlePlotInfoFX

public class WhistlePlotInfoFX extends TDDataInfoFX
Whistles/Moans are long (relatively) tonal sounds which can be plotted on a bearing/amplitude display and/or spectrogram.
Author:
Jamie Macaulay.
  • Constructor Details

  • Method Details

    • getDataValue

      public Double getDataValue(PamDataUnit pamDataUnit)
      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 class TDDataInfoFX
      Returns:
      data value or null if this data point should not be plotted.
    • getScaleInfo

      public TDScaleInfo getScaleInfo()
      Overrides:
      getScaleInfo in class TDDataInfoFX
      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 class TDDataInfoFX
      Parameters:
      pamDataUnit - data unit to draw
      g - graphicsContext handle to draw on
      type - 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 unit
      wmControl -
      fftLength - - the FFT length in samples
      fftHop - - the FFT hop in samples
      sampleRate - - the sample rate in samples per second
      g - - the graphics handle
      tdprojector - - projector which converts pixels to time, frequency and vice versa.
      scrollStart - - the scroll start
      type - - type flag for plotting
      fillCol - - the fill colour
      linCol - - the line colour.
      orientation - - orientation
      windowRect - - window describing window pixel dimensions to draw on
      useKhz - - 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 unit
      wmControl -
      fftLength - - the FFT length in samples
      fftHop - - the FFT hop in samples
      sampleRate - - the sample rate in samples per second
      g - - the graphics handle
      tdprojector - - projector which converts pixels to time, frequency and vice versa.
      scrollStart - - the scroll start
      type - - type flag for plotting
      fillCol - - the fill colour
      linCol - - the line colour.
      useKhz - - true to pot with kHz instead of Hz
      orientation - - orientation
      windowRect - - window describing window pixel dimensions to draw on
      Returns:
      a 2D path in pixels of the fragment.
    • getSymbolChooser

      public TDSymbolChooserFX getSymbolChooser()
      Specified by:
      getSymbolChooser in class TDDataInfoFX
      Returns:
      a class containing functions to chose a symbol to plot.
    • getWmControl

      public WhistleMoanControl getWmControl()
      Get the whistle and moan control.
      Returns:
      the whistle and moan control.
    • getSourceDataBlock

      public PamDataBlock 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 class TDDataInfoFX
      Returns:
      the source data block.
      See Also:
      • invalid @see
        WhistlePlotInfo
    • getGraphSettingsPane

      public TDSettingsPane getGraphSettingsPane()
      Description copied from class: TDDataInfoFX
      Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.
      Overrides:
      getGraphSettingsPane in class TDDataInfoFX
      Returns:
      sliding dialog component.
    • getWhistleSymbolChooser

      public WhistleTDSymbolChooser getWhistleSymbolChooser()
      Get the whistle symbol chooser.
      Returns:
      the whistle symbol chooser.
    • getDDataProvider

      public DDDataInfo<ConnectedRegionDataUnit> getDDataProvider(DetectionPlotDisplay detectionDisplay)
      The detection display data info provider. This allows detection to be plotted in right click panes
      Overrides:
      getDDataProvider in class TDDataInfoFX
      Returns:
      the data info for the detection type./