ClickTOADCalculator

java.lang.Object

PamguardMVC.toad.GenericTOADCalculator

clickDetector.toad.ClickTOADCalculator

All Implemented Interfaces:: PamSettings, SettingsNameProvider, TOADCalculator

public class ClickTOADCalculator extends GenericTOADCalculator

Constructor Summary

Constructors

Constructor

Description

ClickTOADCalculator(ClickControl clickControl)
Method Summary

Modifier and Type

Method

Description

ManagedSettingsPane<?>

getSettingsPane(Window parent, PamDataBlock<?> detectionSource)

TOADInformation

getTOADInformation(List<PamDataUnit> dataUnits, double sampleRate, int channelMap, SnapshotGeometry geometry)

Generate TOAD information for a whole 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 !)
Note that any fancy operations that involve waveform envelopes, etc, are generally handled by the FFTOrganiser.

void

setupCalculator()

Methods inherited from class PamguardMVC.toad.GenericTOADCalculator
getDelayMeasurementParams, getDetectorDataBlock, getFftDataOrganiser, getMaxDelays, getSettingsReference, getSettingsVersion, getTimingSource, getUnitName, getUnitType, hasTOADDialog, isCanUseEnvelope, isCanUseLeadingEdge, makeNaNArray, restoreSettings, setCanUseEnvelope, setCanUseLeadingEdge, setDetectorDataBlock, setFftDataOrganiser, setTimingSource, setTOADSourceParams, showTOADDialog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ClickTOADCalculator
  
  public ClickTOADCalculator(ClickControl clickControl)
  
  Parameters:
  
  clickControl -
Method Details
- setupCalculator
  
  public void setupCalculator()
- getTOADInformation
  
  public TOADInformation getTOADInformation(List<PamDataUnit> dataUnits, double sampleRate, int channelMap, SnapshotGeometry geometry)
  
  Description copied from class: GenericTOADCalculator
  
  Generate TOAD information for a whole 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 !)
  Note that any fancy operations that involve waveform envelopes, etc, are generally handled by the FFTOrganiser. However, this function does need some way of filtering the FFT data for the final cross correlation...
  
  Specified by:
  
  getTOADInformation in interface TOADCalculator
  
  Overrides:
  
  getTOADInformation in class GenericTOADCalculator
  
  Parameters:
  
  channelMap - wanted channels ? Do we need this parameter ?
  
  Returns:
- getSettingsPane
  
  public ManagedSettingsPane<?> getSettingsPane(Window parent, PamDataBlock<?> detectionSource)
  
  Specified by:
  
  getSettingsPane in interface TOADCalculator
  
  Overrides:
  
  getSettingsPane in class GenericTOADCalculator
  
  Parameters:
  
  detectionSource -
  
  Returns:
  
  A settings pane to configure any TOAD options.