Package PamguardMVC.toad

Interface TOADCalculator

All Known Implementing Classes:
ClickTOADCalculator, GenericTOADCalculator, WSLToadCalculator
public interface TOADCalculator
Class to handle TOAD (Time of Arrival Difference) calculations for a particular type of data. Different data types may have to calculate TOAD's in quite different ways and may be able to present different options, e.g. the click TOAD calculator can use click species information to select the analysis bandwidth and can have options on using the leading edge of the click or the envelope, the Whistle calculator will probably use the sweep information and may have to do something cunning to match sounds far apart in time.
Author:
Doug Gillespie

  • Method Details

    • getTOADInformation

      TOADInformation getTOADInformation(List<PamDataUnit> dataUnits, double sampleRate, int channelMap, SnapshotGeometry geometry)
      Generate TOAD information for a while load of data units (or just one - maybe needs a simpler list if there is only one to avoid having to make lots of lists of just one data unit !)
      Parameters:
      channelMap - wanted channels ? Do we need this parameter ?
      dtaUnits - Data units, which are assumed to be of the same sound. If not, then this function should be called separately for sounds considered part of the same group.
      Returns:

    • getSettingsPane

      ManagedSettingsPane<?> getSettingsPane(Window parent, PamDataBlock<?> detectionSource)
      Parameters:
      detectionSource -
      Returns:
      A settings pane to configure any TOAD options.

    • hasTOADDialog

      boolean hasTOADDialog()
      Flag to say there is a full settings dialog
      Returns:
      true if there is a dialog

    • showTOADDialog

      boolean showTOADDialog(Object parentWindow)
      Show the dialog,
      Parameters:
      parentWindow - AWT or FX parent.
      Returns:
      true if OK was pressed and everything OK