ClickDetector

java.lang.Object
- PamguardMVC.PamProcess
- - clickDetector.ClickDetector

All Implemented Interfaces:

PamObserver, ProcessAnnotator
```
public class ClickDetector
extends PamProcess
```
Main click detector process.
Observes a raw data block, filters and thresholds the data to create Click objects

Author:

Doug Gillespie

See Also:
ClickDetection

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ClickDetector.ChannelGroupDetector

Nested Classes
Modifier and Type	Class and Description
`class`	`ClickDetector.ChannelGroupDetector`

Constructor Summary

Constructors
Constructor and Description

ClickDetector(ClickControl clickControl)

Constructors
Constructor and Description
`ClickDetector(ClickControl clickControl)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeOutputFile()`
`void`	`createFilters()`
`ClickDetector.ChannelGroupDetector`	`findChannelGroupDetector(int channelBitmap)`
`boolean`	`flushDataBlockBuffers(long maxWait)` Work through all the output datablocks and wait for their internal buffers to flush through.
`ClickDetector.ChannelGroupDetector`	`getChannelGroupDetector(int i)`
`ClickBinaryDataSource`	`getClickBinaryDataSource()`
`ClickControl`	`getClickControl()`
`long`	`getClickCount()`
`ClickDataBlock`	`getClickDataBlock()`
`Correlations`	`getCorrelations()`
`FFTFilter`	`getFFTFilter(FFTFilterParams fftFilterParams)` Get an FFT filter, mainly used to generate filtered waveforms within click detections.
`PamRawDataBlock[]`	`getFilteredDataBlocks()`
`Hilbert`	`getHilbert()`
`int`	`getnChannelGroups()`
`OfflineEventDataBlock`	`getOfflineEventDataBlock()`
`OfflineEventLogging`	`getOfflineEventLogging()`
`PamDataBlock<ClickDetection>`	`getOutputClickData()`
`long`	`getRequiredDataHistory(PamObservable o, java.lang.Object arg)`
`long`	`getSamplesProcessed()`
`long`	`getStartTimeMillis()`
`PamDataBlock<ClickDetection>`	`getTrackedClicks()`
`PamDataBlock<TriggerLevelDataUnit>`	`getTriggerDataBlock()`
`ClickTriggerFunctionDataBlock`	`getTriggerFunctionDataBlock()`
`void`	`masterClockUpdate(long timeMilliseconds, long sampleNumber)`
`void`	`newData(PamObservable obs, PamDataUnit newData)`
`void`	`newParameters()`
`void`	`notifyArrayChanged()`
`boolean`	`openOutputFile(boolean doHeader)`
`void`	`pamStart()` Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).
`void`	`pamStop()` Stops the process.
`void`	`prepareProcess()` Called for each process before any of them receive the PamStart command
`void`	`processNewBuoyData(BuoyStatusDataUnit buoyStatus, PamDataUnit dataUnit)`
`boolean`	`reWriteClick(ClickDetection click, boolean waveformToo)`
`void`	`secondTimer(long sampleNumber)`
`void`	`setSampleRate(float sampleRate, boolean notify)` New sample rate
`void`	`setupProcess()` called for every process once the systemmodel has been created.
`boolean`	`wantClick(ClickDetection click, ClickIdInformation idInfo)` Return true if the click should be processed and stored.

Methods inherited from class PamguardMVC.PamProcess
absMillisecondsToSamples, absSamplesToMilliseconds, addOutputDataBlock, changedThreading, clearOldData, createAnnotations, destroyProcess, fillXMLElement, getAncestorDataBlock, getAnnotation, getChainPosition, getCpuPercent, getNumAnnotations, getNumOutputDataBlocks, getObserverName, getObserverObject, getOfflineData, getOutputDataBlock, getOutputDataBlocks, getPamControlledUnit, getParentDataBlock, getParentProcess, getProcessName, getRawSourceDataBlock, getSampleRate, getSourceDataBlock, getSourceProcess, isCanMultiThread, makePamProcess, noteNewSettings, notifyModelChanged, relMillisecondsToSamples, relSamplesToMilliseconds, removeAllDataBlocks, removeObservable, removeOutputDatablock, resetDataBlocks, saveViewerData, setCanMultiThread, setParentDataBlock, setParentDataBlock, setProcessName, toString, update, updateData

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

- Constructor Detail
  - ClickDetector
```
public ClickDetector(ClickControl clickControl)
```
- Method Detail
  - setSampleRate
```
public void setSampleRate(float sampleRate,
                 boolean notify)
```
    Description copied from interface: PamObserver
    
    New sample rate
    
    Specified by:
    
    setSampleRate in interface PamObserver
    
    Overrides:
    
    setSampleRate in class PamProcess
    
    notify - Notify other PamObservers and PamObservables in the chain.
  - setupProcess
```
public void setupProcess()
```
    Description copied from class: PamProcess
    
    called for every process once the systemmodel has been created. this is a good time to check out and find input data blocks and similar tasks.
    
    Overrides:
    
    setupProcess in class PamProcess
  - createFilters
```
public void createFilters()
```
  - newParameters
```
public void newParameters()
```
  - getClickDataBlock
```
public ClickDataBlock getClickDataBlock()
```
    Returns:
    The main output click data block.
  - getOfflineEventDataBlock
```
public OfflineEventDataBlock getOfflineEventDataBlock()
```
    Returns:
    the offlineEventDataBlock
  - getRequiredDataHistory
```
public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)
```
    Specified by:
    
    getRequiredDataHistory in interface PamObserver
    
    Overrides:
    
    getRequiredDataHistory in class PamProcess
    
    Parameters:
    o - PamObservable class requiring the data
    arg - optional argument from PamObservable
    
    Returns:
    time in milliseconds requried by data held in PamObservable
  - secondTimer
```
public void secondTimer(long sampleNumber)
```
  - newData
```
public void newData(PamObservable obs,
           PamDataUnit newData)
```
    Overrides:
    
    newData in class PamProcess
  - masterClockUpdate
```
public void masterClockUpdate(long timeMilliseconds,
                     long sampleNumber)
```
    Specified by:
    
    masterClockUpdate in interface PamObserver
    
    Overrides:
    
    masterClockUpdate in class PamProcess
  - prepareProcess
```
public void prepareProcess()
```
    Description copied from class: PamProcess
    
    Called for each process before any of them receive the PamStart command
    
    Overrides:
    
    prepareProcess in class PamProcess
  - pamStart
```
public void pamStart()
```
    Description copied from class: PamProcess
    
    Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).
    
    Specified by:
    
    pamStart in class PamProcess
  - processNewBuoyData
```
public void processNewBuoyData(BuoyStatusDataUnit buoyStatus,
                      PamDataUnit dataUnit)
```
    Overrides:
    
    processNewBuoyData in class PamProcess
  - openOutputFile
```
public boolean openOutputFile(boolean doHeader)
```
  - closeOutputFile
```
public void closeOutputFile()
```
  - pamStop
```
public void pamStop()
```
    Description copied from class: PamProcess
    
    Stops the process.
    
    Specified by:
    
    pamStop in class PamProcess
  - getStartTimeMillis
```
public long getStartTimeMillis()
```
  - reWriteClick
```
public boolean reWriteClick(ClickDetection click,
                   boolean waveformToo)
```
  - getClickControl
```
public ClickControl getClickControl()
```
  - getSamplesProcessed
```
public long getSamplesProcessed()
```
  - getClickCount
```
public long getClickCount()
```
  - getTriggerDataBlock
```
public PamDataBlock<TriggerLevelDataUnit> getTriggerDataBlock()
```
  - getOutputClickData
```
public PamDataBlock<ClickDetection> getOutputClickData()
```
  - flushDataBlockBuffers
```
public boolean flushDataBlockBuffers(long maxWait)
```
    Description copied from class: PamProcess
    
    Work through all the output datablocks and wait for their internal buffers to flush through.
    This is used when stopping PAMGUARD to ensure that all data complete processing before anything else happens.
    
    Overrides:
    
    flushDataBlockBuffers in class PamProcess
    
    Parameters:
    maxWait - maxWait time in milliseconds.
    
    Returns:
    true if successful, or false if there was a timeout.
  - wantClick
```
public boolean wantClick(ClickDetection click,
                ClickIdInformation idInfo)
```
    Return true if the click should be processed and stored.
    If there is no online classification, we want everything If there is classification, but we've not told it to discard, etc
    
    Parameters:
    click -
    idInfo -
    
    Returns:
  - getFilteredDataBlocks
```
public PamRawDataBlock[] getFilteredDataBlocks()
```
  - getTriggerFunctionDataBlock
```
public ClickTriggerFunctionDataBlock getTriggerFunctionDataBlock()
```
  - getTrackedClicks
```
public PamDataBlock<ClickDetection> getTrackedClicks()
```
  - getHilbert
```
public Hilbert getHilbert()
```
  - notifyArrayChanged
```
public void notifyArrayChanged()
```
  - findChannelGroupDetector
```
public ClickDetector.ChannelGroupDetector findChannelGroupDetector(int channelBitmap)
```
  - getClickBinaryDataSource
```
public ClickBinaryDataSource getClickBinaryDataSource()
```
    Returns:
    the clickBinaryDataSource
  - getFFTFilter
```
public FFTFilter getFFTFilter(FFTFilterParams fftFilterParams)
```
    Get an FFT filter, mainly used to generate filtered waveforms within click detections.
    
    Parameters:
    fftFilterParams -
    
    Returns:
    FFT filter object.
  - getCorrelations
```
public Correlations getCorrelations()
```
  - getnChannelGroups
```
public int getnChannelGroups()
```
    Returns:
    the nChannelGroups
  - getChannelGroupDetector
```
public ClickDetector.ChannelGroupDetector getChannelGroupDetector(int i)
```
  - getOfflineEventLogging
```
public OfflineEventLogging getOfflineEventLogging()
```
    Returns:
    the offlineEventLogging

Class ClickDetector

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class PamguardMVC.PamProcess

Methods inherited from class java.lang.Object

Constructor Detail

ClickDetector

Method Detail

setSampleRate

setupProcess

createFilters

newParameters

getClickDataBlock

getOfflineEventDataBlock

getRequiredDataHistory

secondTimer

newData

masterClockUpdate

prepareProcess

pamStart

processNewBuoyData

openOutputFile

closeOutputFile

pamStop

getStartTimeMillis

reWriteClick

getClickControl

getSamplesProcessed

getClickCount

getTriggerDataBlock

getOutputClickData

flushDataBlockBuffers

wantClick

getFilteredDataBlocks

getTriggerFunctionDataBlock

getTrackedClicks

getHilbert

notifyArrayChanged

findChannelGroupDetector

getClickBinaryDataSource

getFFTFilter

getCorrelations

getnChannelGroups

getChannelGroupDetector

getOfflineEventLogging