Package clickDetector

Class ClickDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<ClickDetection>

PamguardMVC.AcousticDataBlock<ClickDetection>

clickDetector.ClickDataBlock

All Implemented Interfaces:

AlarmDataSource, OrganisedFFTData, FFTDataHolderBlock, GroupedDataSource

Direct Known Subclasses:

TrackedClickDataBlock

public class ClickDataBlock
extends AcousticDataBlock<ClickDetection>
implements AlarmDataSource, GroupedDataSource, OrganisedFFTData, FFTDataHolderBlock

Field Summary

Fields

Modifier and Type	Field	Description
protected ClickControl	clickControl

Fields inherited from class PamguardMVC.PamDataBlock

ITERATOR_END, MATCH_AFTER, MATCH_BEFORE, MATCH_EXACT, MIX_DONOTHING, MIX_INTODATABASE, MIX_OUTOFDATABASE, naturalLifetime, NOTIFY_NEW_DATA, NOTIFY_UPDATE_DATA, pamDataUnits, parentProcess, POSITION_AFTER, POSITION_BEFORE, REFERENCE_ABSOLUTE, REFERENCE_CURRENT, REQUEST_DATA_LOADED, REQUEST_DATA_PARTIAL_LOAD, REQUEST_EXCEPTION, REQUEST_INTERRUPTED, REQUEST_NO_DATA, REQUEST_SAME_REQUEST, unitsAdded, unitsRemoved, unitsUpdated

Fields inherited from class PamguardMVC.PamObservable

masterClockSample, objectChanged, overlayDraw, pamProfiler

Constructor Summary

Constructors

Constructor	Description
ClickDataBlock(ClickControl clickControl, PamProcess parentProcess, int channelMap)

Method Summary

Modifier and Type	Method	Description
AlarmCounterProvider	getAlarmCounterProvider()	Get an alarmCounterProvider which can then generate any number of alarm counters for a datablock.
ClickControl	getClickControl()	Get a reference to the click control which owns this data block
DataAutomationInfo	getDataAutomationInfo()	Get the level of automation employed by the generation of these data.
DataBlockSpeciesManager<ClickDetection>	getDatablockSpeciesManager()	Get information about species types that may occur within this data block.
DataSelectorCreator	getDataSelectCreator()
double[]	getDurationRange()	Get the nominal range of durations of sounds that might be detected by this detector (if applicable).
FFTDataOrganiser	getFFTDataOrganiser()
int[]	getFFTparams()	Return the fft parameters in the following format: int[0] = fft length int[1] = fft hop
GroupedSourceParameters	getGroupSourceParameters()
LocalisationAlgorithm	getLocalisationAlgorithm()	Find localisation algorithm for this data.
OfflineClickLogging	getOfflineClickLogging()
OfflineDataMap	getPrimaryDataMap()	New plan - always use the binary store if it has any data at all.
TethysDataProvider	getTethysDataProvider(TethysControl tethysControl)	Gets a data provider for Tethys.
TOADCalculator	getTOADCalculator()
SQLLogging	getUIDRepairLogging()
boolean	loadViewerData(OfflineDataLoadInfo offlineDataLoadInfo, ViewLoadObserver loadObserver)	Click detector loading has to be a bit different to normal - first data are loaded from the binary store, then a subset of these data are loaded from the Offline database.
void	notifyModelChanged(int changeType)	Receive notifications from the main PamController.
protected int	removeOldUnitsS(long mastrClockSample)
boolean	saveViewerData()	Saves data in this data block in offline viewer mode.
void	setForceAmplitudeUpdate()	Set a forced click amplitude update.

Methods inherited from class PamguardMVC.AcousticDataBlock

findParentSource, getChannelListManager, getDataBlockXML, getParentSourceData, prepareAmplitudeCalculations, prepareChannelLists

Methods inherited from class PamguardMVC.PamDataBlock

addDataAnnotationType, addLocalisationContents, addObserver, addObserver, addOfflineDataMap, addOldPamData, addPamData, addPamData, autoEffortProvider, autoSetDataBlockMixMode, cancelDataOrder, cancelDataOrder, checkOfflineDataUIDs, clearAll, clearAll, clearChannelIterators, clearDeletedList, clearOnViewerLoad, copyDataList, createProcessAnnotations, createProcessAnnotations, dispose, dumpBlockContents, dumpBufferStatus, findAnnotation, findAnnotation, findByDatabaseIndex, findDataUnit, findDataUnit, findFirstUnitAfter, findLastUnitBefore, findUnitByUIDandUTC, findUnitsinInterval, getAbsoluteDataUnit, getAnnotationHandler, getARealChannel, getBackgroundManager, getBespokeDataMapGraphic, getBinaryDataSource, getCanLog, getChannelIterator, getChannelIteratorCount, getChannelMap, getChannelsForSequenceMap, getClosestUnitMillis, getClosestUnitMillis, getClosestUnitMillisUsingSeq, getCrossReferenceInformation, getCumulativeGain, getCurrentViewDataEnd, getCurrentViewDataStart, getDataCopy, getDataCopy, getDataCopy, getDataCopy, getDataCopyFromEnd, getDataCopyFromStart, getDataGain, getDatagrammedMap, getDatagramProvider, getDataName, getDataSelector, getDataSelector, getDataSelector, getDataUnit, getDataUnitMenuItems, getDataUnitPopupMenu, getEffortProvider, getFirstRawSourceDataBlock, getFirstUnit, getFirstUnit, getFirstUnitAfter, getFirstViewerUID, getFrequencyRange, getHydrophoneMap, getJSONDataSource, getLastUnit, getLastUnit, getLastUnitMillis, getLastViewerUID, getListIterator, getListIterator, getListIteratorFromEnd, getListIteratorFromStart, getLocalisationContents, getLogging, getLoggingName, getLongDataName, getMixedDirection, getMyDataUnits, getNanoTimeCalculator, getNaturalLifetime, getNaturalLifetimeMillis, getNextDataStart, getNextUnit, getNextUnit, getNumOfflineDataMaps, getNumRequiredBeforeLoadTime, getOfflineData, getOfflineDataMap, getOfflineDataMap, getPamConfiguration, getPamSymbolManager, getParentProcess, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnitFromSeq, getPreceedingUnitFromSeq, getPrevDataEnd, getProcessAnnotations, getQuickId, getQuickId2, getRawSourceDataBlock, getRawSourceDataBlock2, getRecordingTrigger, getRecycledUnit, getRecyclingStoreLength, getRemovedItems, getReverseChannelIterator, getSampleRate, getSaveRequirements, getSequenceCount, getSequenceIterator, getSequenceMap, getSequenceMapObject, getShouldBinary, getShouldLog, getShouldLog, getSourceDataBlock, getSourceProcess, getSuperDetectionClass, getSynchLock, getTaskDataCopy, getUidHandler, getUniqueParentList, getUnitClass, getUnitIndex, getUnitsCount, getUnitsCountFromTime, hasDataRange, isCanClipGenerate, isClearAtStart, isLinkGpsData, isOffline, isRecycling, loadViewerData, masterClockUpdate, needViewerDataLoad, noteNewSettings, notifyOfflineObservers, orderOfflineData, orderOfflineData, orderOfflineData, pamStart, pamStop, remove, remove, remove, removedDataUnit, removeOfflineDataMap, removeOldUnitsT, reset, setAnnotationHandler, setBackgroundManager, setBinaryDataSource, setCanClipGenerate, setChannelMap, setClearAtStart, setCurrentViewDataEnd, setCurrentViewDataStart, setDatagramProvider, setDataName, setDataSelectCreator, setEffortProvider, setJSONDataSource, setLinkGpsData, setLocalisationContents, SetLogging, setMixedDirection, setNanoTimeCalculator, setNaturalLifetime, setNaturalLifetimeMillis, setPamSymbolManager, setParentProcess, setRecordingTrigger, setRecycling, setRecyclingStoreLength, setSampleRate, setSequenceMap, setShouldBinary, setShouldLog, setSynchLock, setUidHandler, shouldNotify, sortData, sortOutputMaps, stopTimer, toString, updatePamData

Methods inherited from class PamguardMVC.PamObservable

addInstantObserver, canDraw, canDraw, clearchanged, countObservers, createKeyItem, deleteObserver, deleteObservers, drawDataUnit, findThreadedObserver, getCPUPercent, getCPUPercent, getHoverText, getInstantObservers, getLongestObserver, getMaxThreadJitter, getOverlayDraw, getPamObserver, getPamObservers, getRequiredHistory, isInstantObserver, notifyInstantObservers, notifyNornalObservers, notifyObservers, notifyObservers, setChanged, setOverlayDraw, updateObservers, waitForThreadedObservers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

clickControl

protected ClickControl clickControl

Constructor Details

ClickDataBlock

public ClickDataBlock(ClickControl clickControl,
 PamProcess parentProcess,
 int channelMap)

Method Details

loadViewerData

public boolean loadViewerData(OfflineDataLoadInfo offlineDataLoadInfo,
 ViewLoadObserver loadObserver)

Click detector loading has to be a bit different to normal - first data are loaded from the binary store, then a subset of these data are loaded from the Offline database. These database clicks are then matched to the data in the

Overrides:

loadViewerData in class PamDataBlock<ClickDetection>

Parameters:

offlineDataLoadInfo - - the load object which contains all info on the data to be loaded.

loadObserver - - the load observer. Can be used as a callback for load progress.

saveViewerData

public boolean saveViewerData()

Description copied from class: PamDataBlock

Saves data in this data block in offline viewer mode.

Overrides:

saveViewerData in class PamDataBlock<ClickDetection>

Returns:

true if data found and saved.

getPrimaryDataMap

public OfflineDataMap getPrimaryDataMap()

Description copied from class: PamDataBlock

New plan - always use the binary store if it has any data at all. If the binary store doesn't exist or is empty, only then use the database.

Overrides:

getPrimaryDataMap in class PamDataBlock<ClickDetection>

Returns:

a data map

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamDataBlock

Receive notifications from the main PamController.

Overrides:

notifyModelChanged in class AcousticDataBlock<ClickDetection>

Parameters:

changeType -

getUIDRepairLogging

public SQLLogging getUIDRepairLogging()

Overrides:

getUIDRepairLogging in class PamDataBlock<ClickDetection>

getOfflineClickLogging

public OfflineClickLogging getOfflineClickLogging()

Returns:

the offlineClickLogging

removeOldUnitsS

protected int removeOldUnitsS(long mastrClockSample)

Overrides:

removeOldUnitsS in class PamDataBlock<ClickDetection>

getAlarmCounterProvider

public AlarmCounterProvider getAlarmCounterProvider()

Description copied from interface: AlarmDataSource

Get an alarmCounterProvider which can then generate any number of alarm counters for a datablock.

Specified by:

getAlarmCounterProvider in interface AlarmDataSource

Returns:

alarm Counter provider for that control. This more complicated system enables multiple alarms to be hung off the same data block.

getDataSelectCreator

public DataSelectorCreator getDataSelectCreator()

Overrides:

getDataSelectCreator in class PamDataBlock<ClickDetection>

Returns:

an object that can create data selectors to sub select data from within this type of data block.

getGroupSourceParameters

public GroupedSourceParameters getGroupSourceParameters()

Specified by:

getGroupSourceParameters in interface GroupedDataSource

Returns:

the current group source parameters for this data source.

getClickControl

public ClickControl getClickControl()

Get a reference to the click control which owns this data block

Returns:

click control.

getTOADCalculator

public TOADCalculator getTOADCalculator()

Overrides:

getTOADCalculator in class PamDataBlock<ClickDetection>

Returns:

A calculator for Time of Arrival Difference Calculations

getFFTDataOrganiser

public FFTDataOrganiser getFFTDataOrganiser()

Specified by:

getFFTDataOrganiser in interface OrganisedFFTData

getDurationRange

public double[] getDurationRange()

Description copied from class: PamDataBlock

Get the nominal range of durations of sounds that might be detected by this detector (if applicable). This is pretty crude, but will give an indication of which detectors might work with which types of sound.
can return null, 0 and Double.Infinity are also acceptable values.

Overrides:

getDurationRange in class PamDataBlock<ClickDetection>

Returns:

duration range in seconds of sounds this detector can sensibly detect

getFFTparams

public int[] getFFTparams()

Description copied from interface: FFTDataHolderBlock

Return the fft parameters in the following format:

• int[0] = fft length
• int[1] = fft hop

Specified by:

getFFTparams in interface FFTDataHolderBlock

Returns:

fft length and hop, respectively, in an int array

setForceAmplitudeUpdate

public void setForceAmplitudeUpdate()

Set a forced click amplitude update. This means the next time getAmplitude is called the amplitude value is recalculated using latest sensitivity/gain values. TODO - this could be moved into AcousticDataBlock?

getDatablockSpeciesManager

public DataBlockSpeciesManager<ClickDetection> getDatablockSpeciesManager()

Description copied from class: PamDataBlock

Get information about species types that may occur within this data block. Primarily for conversion into Tethys compatible data, but may prove to have other uses.

Overrides:

getDatablockSpeciesManager in class PamDataBlock<ClickDetection>

Returns:

Types of species information available within this datablock.

getTethysDataProvider

public TethysDataProvider getTethysDataProvider(TethysControl tethysControl)

Description copied from class: PamDataBlock

Gets a data provider for Tethys. These will probably need to be bespoke, but for now will autogenerate based on the SQLLogging information.

Overrides:

getTethysDataProvider in class PamDataBlock<ClickDetection>

Returns:

the tethysDataProvider

getDataAutomationInfo

public DataAutomationInfo getDataAutomationInfo()

Description copied from class: PamDataBlock

Get the level of automation employed by the generation of these data. Should ideally be completed for everything providing data to Tethys.

Overrides:

getDataAutomationInfo in class PamDataBlock<ClickDetection>

Returns:

level of automation for this data block.

getLocalisationAlgorithm

public LocalisationAlgorithm getLocalisationAlgorithm()

Description copied from class: PamDataBlock

Find localisation algorithm for this data. This may be within the owning module, or a downstream algorithm.

Overrides:

getLocalisationAlgorithm in class PamDataBlock<ClickDetection>

Returns:

first found localisation algorithm or null;