ClickDetection

java.lang.Object
- PamguardMVC.PamDataUnit
- - PamDetection.AcousticDataUnit
  - - PamDetection.PamDetection<PamDetection,PamDetection>
    - - clickDetector.ClickDetection

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>
```
public class ClickDetection
extends PamDetection<PamDetection,PamDetection>
```
Class for Click Detector clicks.

Author:

Doug Gillespie

Field Summary

Fields
Modifier and Type Field and Description

static int CLICK_CLICK

static int CLICK_FLAG_ECHO

static int CLICK_NOISEWAVE
- Fields inherited from class PamDetection.AcousticDataUnit
  AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Fields
Modifier and Type	Field and Description
`static int`	`CLICK_CLICK`
`static int`	`CLICK_FLAG_ECHO`
`static int`	`CLICK_NOISEWAVE`

Constructor Summary

Constructors
Constructor and Description
`ClickDetection(ClickDetector clickDetector)`
`ClickDetection(int channelBitmap, long startSample, long duration, ClickDetector clickDetector, ClickDetector.ChannelGroupDetector channelGroupDetector, int triggerList)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSuperDetection(PamDetection superDetection)`
`double[]`	`applyHanningWindow(double[] data)` apply a Hanning window to the passed dataset.
`boolean`	`calculateAmplitude(int channel)` Calculate the peak waveform amplitude making the correction of rotating teh wave so it's two ends are at zero.
`double`	`clickLength(double percent)` Calculates the length of a click in seconds averaged over all channels
`double`	`clickLength(int channel, double percent)` Calculates the length of a click in seconds for a particular channel
`void`	`freeClickMemory()` Free up as much click memory as possible.
`double`	`getAmplitude(int channel)`
`double[]`	`getAnalyticWaveform(int iChan)` Get the analytic waveform for a given channel
`double[]`	`getAnalyticWaveform(int iChan, boolean filtered, FFTFilterParams fftFilterParams)` Get filtered or unfiltered analytic waveform.
`double`	`getAngle()` Returns the angle in degrees for compatibilty with older version of click detector
`double[]`	`getCepstrum(int channel, int cepLength)` Calculate the cepstrum for a click channel.
`ClickDetector.ChannelGroupDetector`	`getChannelGroupDetector()`
`ClickDetector`	`getClickDetector()`
`int`	`getClickFlags()`
`ClickLocalisation`	`getClickLocalisation()`
`byte`	`getClickType()`
`static Complex[]`	`getComplexSpectrum(double[] rawData, int fftLength)` Returns the complex spectrum for waveform using a set FFT length
`Complex[]`	`getComplexSpectrum(int channel)` Returns the complex spectrum for a given channel using the shortest possible FFT length
`Complex[]`	`getComplexSpectrum(int channel, int fftLength)` Returns the complex spectrum for a given channel using a set FFT length
`Complex[]`	`getComplexSpectrumHann(int channel, int fftLength)` Returns the complex spectrum for a given channel using a set FFT length as getComplexSpectrum, but applies a Hanning window to the raw data first
`byte[][]`	`getCompressedWaveData()` Get compressed waveform data in int8 format, scaled so that the maximum range >-127 to +127 is utilised.
`int`	`getCurrentSpectrumLength()`
`byte`	`getDataType()`
`double[]`	`getDelays()` return a list of delays.
`AbstractDetectionMatch`	`getDetectionMatch()`
`AbstractDetectionMatch`	`getDetectionMatch(int type)`
`int`	`getEventId()`
`double[][]`	`getFilteredAnalyticWaveform(FFTFilterParams fftFilterParams)` Get the analytic waveform for all channels if filter params = null, then return normal analytic waveform
`double[]`	`getFilteredAnalyticWaveform(FFTFilterParams fftFilterParams, int iChan)` Get a filtered version of the analytic waveform.
`double[][]`	`getFilteredWaveData(FFTFilterParams filterParams)` Get filtered waveform data for all channels.
`double[]`	`getFilteredWaveData(FFTFilterParams filterParams, int channelIndex)` Get filtered waveform data for a single channel.
`double`	`getICI()`
`double[]`	`getMagnitude(int channel, int fftLength, boolean hann)` Returns the magnitude of the complex spectrum for a given channel.
`double`	`getMeanAmplitude()`
`double`	`getMeanFrequency(double[] searchRange)`
`int`	`getNChan()`
`int`	`getOfflineEventID()`
`double[]`	`getPowerSpectrum(int channel)` Get the power spectrum of the entire click.
`double[]`	`getPowerSpectrum(int channel, int fftLength)` Returns the power spectrum for a given channel (square of magnitude of complex spectrum)
`double[]`	`getRotationCorrection(int channel)` GEt a correction based on the slope of the waveform which can be used to remove large DC / LF offsets in the waveform.
`int`	`getShortestFFTLength()`
`double`	`getTempICI()`
`double[]`	`getTotalPowerSpectrum(int fftLength)` Returns the sum of the power spectra for all channels
`double`	`getWaveAmplitude()`
`double[][]`	`getWaveData()`
`double[][]`	`getWaveData(boolean filtered, FFTFilterParams fftFilterParams)` convenience method to get filtered or unfiltered data for a single channel.
`double[]`	`getWaveData(int channelIndex)` Get raw waveform data for a given click channel index.
`double[]`	`getWaveData(int channelIndex, boolean filtered, FFTFilterParams fftFilterParams)` convenience method to get filtered or unfiltered data for a single channel.
`ZeroCrossingStats[]`	`getZeroCrossingStats()`
`boolean`	`hasComplexSpectrum()` Find out whether there are complex spectrum data - and if there are, data may get cleaned up.
`double`	`inBandEnergy(double[] freqs)` Calculates the total energy within a particular frequency band
`boolean`	`isEcho()`
`boolean`	`isTracked()`
`double`	`peakFrequency(double[] searchRange)`
`double`	`peakFrequencyWidth(double peakFrequency, double percent)`
`double[]`	`peakFrequencyWidth(double peakFrequency, int dBDrop)`
`double[]`	`peakFrequencyWidthChan(double peakFrequency, int dBDrop, int channel, boolean hann)` Returns the frequency width of a drop in dBDrop decibels to either side of the peak frequency.
`void`	`removeSuperDetection(PamDetection superDetection)`
`void`	`setAmplitude(int channel, double amplitude)` Set the amplitude for a given channel
`void`	`setChannelBitmap(int channelBitmap)`
`void`	`setClickDetector(ClickDetector clickDetector)`
`void`	`setClickFlags(int clickFlags)`
`void`	`setClickLocalisation(ClickLocalisation clickLocalisation)`
`void`	`setClickType(byte clickType)`
`void`	`setComplexSpectrum()`
`void`	`setCompressedData(byte[][] compressedWaveData, double waveAmplitude)` Set the compressed wave data (used when reading back from file).
`void`	`setDataType(byte dataType)`
`void`	`setDelay(int iDelay, double delay)` Set the time of arrival delay in samples.
`void`	`setEcho(boolean isEcho)`
`void`	`setEventId(int eventId)`
`void`	`setICI(double iCI)`
`void`	`setOfflineEventID(int offlineEventID)`
`void`	`setTempICI(double tempICI)`
`void`	`setTracked(boolean tracked)`
`void`	`setWaveData(double[][] waveData)`
`void`	`setZeroCrossingStats(ZeroCrossingStats[] zcs)`

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

- Field Detail
  - CLICK_CLICK
```
public static final int CLICK_CLICK
```
    See Also:
    Constant Field Values
  - CLICK_NOISEWAVE
```
public static final int CLICK_NOISEWAVE
```
    See Also:
    Constant Field Values
  - CLICK_FLAG_ECHO
```
public static final int CLICK_FLAG_ECHO
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ClickDetection
```
public ClickDetection(int channelBitmap,
              long startSample,
              long duration,
              ClickDetector clickDetector,
              ClickDetector.ChannelGroupDetector channelGroupDetector,
              int triggerList)
```
  - ClickDetection
```
public ClickDetection(ClickDetector clickDetector)
```
- Method Detail
  - getShortestFFTLength
```
public int getShortestFFTLength()
```
  - isTracked
```
public boolean isTracked()
```
  - setTracked
```
public void setTracked(boolean tracked)
```
  - getEventId
```
public int getEventId()
```
  - setEventId
```
public void setEventId(int eventId)
```
  - isEcho
```
public boolean isEcho()
```
    Returns:
    true if the echo flag is set.
  - setEcho
```
public void setEcho(boolean isEcho)
```
    Parameters:
    isEcho - set the click echo flag.
  - getComplexSpectrum
```
public Complex[] getComplexSpectrum(int channel)
```
    Returns the complex spectrum for a given channel using the shortest possible FFT length
    
    Parameters:
    channel -
    
    Returns:
    The complex spectrum
  - setComplexSpectrum
```
public void setComplexSpectrum()
```
  - getComplexSpectrum
```
public Complex[] getComplexSpectrum(int channel,
                           int fftLength)
```
    Returns the complex spectrum for a given channel using a set FFT length
    
    Parameters:
    channel -
    fftLength -
    
    Returns:
    the complex spectrum
  - getComplexSpectrumHann
```
public Complex[] getComplexSpectrumHann(int channel,
                               int fftLength)
```
    Returns the complex spectrum for a given channel using a set FFT length as getComplexSpectrum, but applies a Hanning window to the raw data first
    
    Parameters:
    channel -
    fftLength -
    
    Returns:
    the complex spectrum
  - getComplexSpectrum
```
public static Complex[] getComplexSpectrum(double[] rawData,
                           int fftLength)
```
    Returns the complex spectrum for waveform using a set FFT length
    
    Parameters:
    waveData -
    
    Returns:
    the complex Spectrum
  - hasComplexSpectrum
```
public boolean hasComplexSpectrum()
```
    Find out whether there are complex spectrum data - and if there are, data may get cleaned up.
    
    Returns:
    true if complex spec data exist.
  - getCurrentSpectrumLength
```
public int getCurrentSpectrumLength()
```
  - getPowerSpectrum
```
public double[] getPowerSpectrum(int channel)
```
    Get the power spectrum of the entire click.
    
    Parameters:
    channel - channel number
    
    Returns:
    power spectrum
  - getCepstrum
```
public double[] getCepstrum(int channel,
                   int cepLength)
```
    Calculate the cepstrum for a click channel.
    
    Parameters:
    channel - cannel
    cepLength - length of cepstrum. If this is 0, then the Cepstrum will be the next binary int up from the click length.
    
    Returns:
    cepstrum. (ifft of the log of the power spectrum)
  - getPowerSpectrum
```
public double[] getPowerSpectrum(int channel,
                        int fftLength)
```
    Returns the power spectrum for a given channel (square of magnitude of complex spectrum)
    
    Parameters:
    channel - channel number
    fftLength -
    
    Returns:
    Power spectrum
  - getMagnitude
```
public double[] getMagnitude(int channel,
                    int fftLength,
                    boolean hann)
```
    Returns the magnitude of the complex spectrum for a given channel. Has the option to apply a hanning window to the raw data before computing the fft
    
    Parameters:
    channel -
    fftLength -
    hann - TRUE=apply hanning window; FALSE=do not apply hanning window
    
    Returns:
  - getTotalPowerSpectrum
```
public double[] getTotalPowerSpectrum(int fftLength)
```
    Returns the sum of the power spectra for all channels
    
    Parameters:
    fftLength -
    
    Returns:
    Sum of power spectra
  - getAnalyticWaveform
```
public double[] getAnalyticWaveform(int iChan)
```
    Get the analytic waveform for a given channel
    
    Parameters:
    iChan - channel index
    
    Returns:
    analytic waveform
  - getAnalyticWaveform
```
public double[] getAnalyticWaveform(int iChan,
                           boolean filtered,
                           FFTFilterParams fftFilterParams)
```
    Get filtered or unfiltered analytic waveform. Easy access method for click detector modules which can let this function work out what they want rather than having to write their own.
    
    Parameters:
    iChan - channel number
    filtered - true if you want data to be filtered
    fftFilterParams - fft filter parameters.
    
    Returns:
    analystic waveform.
  - getFilteredAnalyticWaveform
```
public double[] getFilteredAnalyticWaveform(FFTFilterParams fftFilterParams,
                                   int iChan)
```
    Get a filtered version of the analytic waveform. In principle, this could be made more efficient since the calc is done partly in freqeucny domain - so could save a couple of fft's back and forth.
    
    Parameters:
    fftFilterParams - FFT filter parameters.
    iChan - channel number
    
    Returns:
    envelope of the filtered data.
  - getFilteredAnalyticWaveform
```
public double[][] getFilteredAnalyticWaveform(FFTFilterParams fftFilterParams)
```
    Get the analytic waveform for all channels if filter params = null, then return normal analytic waveform
    
    Parameters:
    fftFilterParams -
    
    Returns:
    analystic waveforms
  - inBandEnergy
```
public double inBandEnergy(double[] freqs)
```
    Calculates the total energy within a particular frequency band
    
    Parameters:
    freqs -
    
    Returns:
    In Band Energy
    See Also:
    BasicClickIdentifier
  - clickLength
```
public double clickLength(double percent)
```
    Calculates the length of a click in seconds averaged over all channels
    
    Parameters:
    percent - Fraction of total click energy to use in the calculation
    
    Returns:
    click length in seconds
    See Also:
    BasicClickIdentifier
  - clickLength
```
public double clickLength(int channel,
                 double percent)
```
    Calculates the length of a click in seconds for a particular channel
    
    Parameters:
    channel -
    percent - Fraction of total click energy to use in the calculation
    
    Returns:
    Click Length (seconds)
    See Also:
    BasicClickIdentifier
  - peakFrequency
```
public double peakFrequency(double[] searchRange)
```
  - peakFrequencyWidth
```
public double peakFrequencyWidth(double peakFrequency,
                        double percent)
```
  - peakFrequencyWidth
```
public double[] peakFrequencyWidth(double peakFrequency,
                          int dBDrop)
```
  - peakFrequencyWidthChan
```
public double[] peakFrequencyWidthChan(double peakFrequency,
                              int dBDrop,
                              int channel,
                              boolean hann)
```
    Returns the frequency width of a drop in dBDrop decibels to either side of the peak frequency. Note that this differs from the method peakFrequencyWidth because it operates only on a single channel, and it uses the magnitude (sqrt(PowerSpectrum)) instead of the PowerSpectrum.
    
    Parameters:
    peakFrequency - The peak frequency in Hz
    dBDrop - The drop in magnitude (in dB) to either side of the peak frequency
    channel - The channel to run the calculations on
    hann - TRUE=apply hanning window, FALSE=do not apply hanning window
    
    Returns:
    a 3-position array with the frequency bin in the first index, the lower frequency in the second index, and the higher frequency in the third index
  - getMeanFrequency
```
public double getMeanFrequency(double[] searchRange)
```
  - getFilteredWaveData
```
public double[] getFilteredWaveData(FFTFilterParams filterParams,
                           int channelIndex)
```
    Get filtered waveform data for a single channel.
    Data are filtered in the frequency domain using an FFT / Inverse FFT.
    
    Parameters:
    filterParams - filter parameters
    channelIndex - channel index
    
    Returns:
    filtered waveform data
  - getFilteredWaveData
```
public double[][] getFilteredWaveData(FFTFilterParams filterParams)
```
    Get filtered waveform data for all channels.
    Data are filtered in the frequency domain using an FFT / Inverse FFT.
    
    Parameters:
    filterParams - filter parameters
    
    Returns:
    array of filtered data
  - getWaveData
```
public double[][] getWaveData(boolean filtered,
                     FFTFilterParams fftFilterParams)
```
    convenience method to get filtered or unfiltered data for a single channel.
    
    Parameters:
    filtered - flag saying you want it filtered
    fftFilterParams - filter parameters.
    
    Returns:
    data filtered or otherwise.
  - getWaveData
```
public double[] getWaveData(int channelIndex,
                   boolean filtered,
                   FFTFilterParams fftFilterParams)
```
    convenience method to get filtered or unfiltered data for a single channel.
    
    Parameters:
    channelIndex - channel index
    filtered - flag saying you want it filtered
    fftFilterParams - filter parameters.
    
    Returns:
    data filtered or otherwise.
  - getWaveData
```
public double[] getWaveData(int channelIndex)
```
    Get raw waveform data for a given click channel index.
    
    Parameters:
    channelIndex - channel index
    
    Returns:
    waveform data
  - getWaveData
```
public double[][] getWaveData()
```
    Returns:
    waveform data for all channels. Convert from compressed (int16) data if necessary.
  - setWaveData
```
public void setWaveData(double[][] waveData)
```
  - getCompressedWaveData
```
public byte[][] getCompressedWaveData()
```
    Get compressed waveform data in int8 format, scaled so that the maximum range >-127 to +127 is utilised.
    
    Returns:
    arrays of waveform data.
  - setCompressedData
```
public void setCompressedData(byte[][] compressedWaveData,
                     double waveAmplitude)
```
    Set the compressed wave data (used when reading back from file).
    
    Parameters:
    compressedWaveData -
    waveAmplitude -
  - getWaveAmplitude
```
public double getWaveAmplitude()
```
    Returns:
    the waveAmplitude - the double precision amplitude of the orignal wave data.
  - freeClickMemory
```
public void freeClickMemory()
```
    Free up as much click memory as possible.
    Ensures that waveform data are retained in a compressed (int8) format so that all other data can be reconstructed if necessary.
  - setDelay
```
public void setDelay(int iDelay,
            double delay)
```
    Set the time of arrival delay in samples.
    
    Parameters:
    delay - delay in samples
  - getDelays
```
public double[] getDelays()
```
    return a list of delays.
    
    Returns:
  - calculateAmplitude
```
public boolean calculateAmplitude(int channel)
```
    Calculate the peak waveform amplitude making the correction of rotating teh wave so it's two ends are at zero.
    
    Parameters:
    channel -
    
    Returns:
    true if calculatoin completed OK.
  - getRotationCorrection
```
public double[] getRotationCorrection(int channel)
```
    GEt a correction based on the slope of the waveform which can be used to remove large DC / LF offsets in the waveform.
    
    Parameters:
    channel -
    
    Returns:
  - setAmplitude
```
public void setAmplitude(int channel,
                double amplitude)
```
    Set the amplitude for a given channel
    
    Parameters:
    channel - channel number
    amplitude - amplitude
  - getAmplitude
```
public double getAmplitude(int channel)
```
  - getAngle
```
public double getAngle()
```
    Returns the angle in degrees for compatibilty with older version of click detector
    
    Returns:
    angle of the click detection in degrees
  - getMeanAmplitude
```
public double getMeanAmplitude()
```
  - getClickLocalisation
```
public ClickLocalisation getClickLocalisation()
```
  - setClickLocalisation
```
public void setClickLocalisation(ClickLocalisation clickLocalisation)
```
  - getDetectionMatch
```
public AbstractDetectionMatch getDetectionMatch(int type)
```
    Overrides:
    
    getDetectionMatch in class PamDataUnit
    
    Returns:
    Returns the large aperture localisation.
  - getDetectionMatch
```
public AbstractDetectionMatch getDetectionMatch()
```
    Overrides:
    
    getDetectionMatch in class PamDataUnit
    
    Returns:
    Returns the large aperture localisation.
  - getNChan
```
public int getNChan()
```
  - setChannelBitmap
```
public void setChannelBitmap(int channelBitmap)
```
    Overrides:
    
    setChannelBitmap in class PamDataUnit
  - setClickType
```
public void setClickType(byte clickType)
```
    Parameters:
    clickType - the clickType (click species) to set
  - getClickType
```
public byte getClickType()
```
    Returns:
    the clickType (click species)
  - getDataType
```
public byte getDataType()
```
    Returns:
    the type of data - click, noise, etc.
  - setDataType
```
public void setDataType(byte dataType)
```
    Parameters:
    dataType - the type of data - click, noise, etc.
  - setClickDetector
```
public void setClickDetector(ClickDetector clickDetector)
```
    Parameters:
    clickDetector - the clickDetector to set
  - getClickDetector
```
public ClickDetector getClickDetector()
```
    Returns:
    the clickDetector
  - getICI
```
public double getICI()
```
    Returns:
    the iCI
  - setICI
```
public void setICI(double iCI)
```
    Parameters:
    iCI - the iCI to set
  - addSuperDetection
```
public void addSuperDetection(PamDetection superDetection)
```
    Overrides:
    
    addSuperDetection in class PamDetection<PamDetection,PamDetection>
  - removeSuperDetection
```
public void removeSuperDetection(PamDetection superDetection)
```
    Overrides:
    
    removeSuperDetection in class PamDetection<PamDetection,PamDetection>
  - getChannelGroupDetector
```
public ClickDetector.ChannelGroupDetector getChannelGroupDetector()
```
  - setClickFlags
```
public void setClickFlags(int clickFlags)
```
    Parameters:
    clickFlags - the clickFlags to set
  - getClickFlags
```
public int getClickFlags()
```
    Returns:
    the clickFlags
  - setTempICI
```
public void setTempICI(double tempICI)
```
    Parameters:
    tempICI - the tempICI to set
  - getTempICI
```
public double getTempICI()
```
    Returns:
    the tempICI
  - getZeroCrossingStats
```
public ZeroCrossingStats[] getZeroCrossingStats()
```
    Returns:
    the ZeroCrossingStats array (array size=number of channels)
  - setZeroCrossingStats
```
public void setZeroCrossingStats(ZeroCrossingStats[] zcs)
```
    Parameters:
    zcs - save the ZeroCrossingStats array (array size=number of channels)
  - applyHanningWindow
```
public double[] applyHanningWindow(double[] data)
```
    apply a Hanning window to the passed dataset. Note that the size of the window is the length of te full dataset that is passed.
    
    Parameters:
    data - a double array
    
    Returns:
    the windowed data array
  - getOfflineEventID
```
public int getOfflineEventID()
```
    Returns:
    the offlineEventID
  - setOfflineEventID
```
public void setOfflineEventID(int offlineEventID)
```
    Parameters:
    offlineEventID - the offlineEventID to set

Class ClickDetection

Field Summary

Fields inherited from class PamDetection.AcousticDataUnit

Constructor Summary

Method Summary

Methods inherited from class PamDetection.PamDetection

Methods inherited from class PamDetection.AcousticDataUnit

Methods inherited from class PamguardMVC.PamDataUnit

Methods inherited from class java.lang.Object

Field Detail

CLICK_CLICK

CLICK_NOISEWAVE

CLICK_FLAG_ECHO

Constructor Detail

ClickDetection

ClickDetection

Method Detail

getShortestFFTLength

isTracked

setTracked

getEventId

setEventId

isEcho

setEcho

getComplexSpectrum

setComplexSpectrum

getComplexSpectrum

getComplexSpectrumHann

getComplexSpectrum

hasComplexSpectrum

getCurrentSpectrumLength

getPowerSpectrum

getCepstrum

getPowerSpectrum

getMagnitude

getTotalPowerSpectrum

getAnalyticWaveform

getAnalyticWaveform

getFilteredAnalyticWaveform

getFilteredAnalyticWaveform

inBandEnergy

clickLength

clickLength

peakFrequency

peakFrequencyWidth

peakFrequencyWidth

peakFrequencyWidthChan

getMeanFrequency

getFilteredWaveData

getFilteredWaveData

getWaveData

getWaveData

getWaveData

getWaveData

setWaveData

getCompressedWaveData

setCompressedData

getWaveAmplitude

freeClickMemory

setDelay

getDelays

calculateAmplitude

getRotationCorrection

setAmplitude

getAmplitude

getAngle

getMeanAmplitude

getClickLocalisation

setClickLocalisation

getDetectionMatch

getDetectionMatch

getNChan

setChannelBitmap

setClickType

getClickType

getDataType

setDataType

setClickDetector

getClickDetector

getICI