Package clickTrainDetector

Class ClickTrainDataBlock<T extends CTDetectionGroupDataUnit>

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<Tunit>

PamguardMVC.superdet.SuperDetDataBlock<T,PamDataUnit>

clickTrainDetector.ClickTrainDataBlock<T>

public class ClickTrainDataBlock<T extends CTDetectionGroupDataUnit>
extends SuperDetDataBlock<T,PamDataUnit>

The click train detector data block. Holds all detected click trains in ClickTrainDataUnits which themselves contain a list of detected data units within a train.

Author:

Jamie Macaulay

Nested Class Summary

Nested classes/interfaces inherited from class PamguardMVC.superdet.SuperDetDataBlock

SuperDetDataBlock.ViewerLoadPolicy

Field Summary

Fields inherited from class PamguardMVC.PamDataBlock

ITERATOR_END, MATCH_AFTER, MATCH_BEFORE, MATCH_EXACT, MIX_DONOTHING, MIX_INTODATABASE, MIX_OUTOFDATABASE, NOTIFY_NEW_DATA, NOTIFY_UPDATE_DATA, 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

Constructor Summary

Constructors

Constructor	Description
ClickTrainDataBlock(ClickTrainControl clickTrainControl, PamProcess parentProcess, String name, int channelMap)

Method Summary

Modifier and Type	Method	Description
void	addPamData(T pamDataUnit)	Adds a new PamDataUnit to the PamDataBlock.
void	addPamData(T pamDataUnit, Long uid)	Adds a new PamDataUnit to the PamDataBlock and force the UID to a specific value.
ClickTrainControl	getClickTrainControl()	Get the click train control.
DataSelectorCreator	getDataSelectCreator()
float	getSampleRate()
boolean	loadViewerData(OfflineDataLoadInfo offlineDataLoadInfo, ViewLoadObserver loadObserver)	Instruction from the viewer scroll manager to load new data.
boolean	needViewerDataLoad(OfflineDataLoadInfo offlineDataLoadInfo)	Do we need to reload offline data ? Default behaviour is to reurn true if the time periods of the data load have changed, false otherwise.
boolean	saveViewerData()	Saves data in this data block in offline viewer mode.
boolean	shouldNotify()
void	updatePamData(T pamDataUnit, long updateTimeMillis)	update a dataunit.

Methods inherited from class PamguardMVC.superdet.SuperDetDataBlock

canSuperDetection, clearOnViewerLoad, dummyClassResolve, findSubDetDataBlock, getLogging, getSubDetectionClass, getSubtableData, getViewerLoadPolicy, makeSubDetectionInfo, reattachSubdetections, setSubtableData, setViewerLoadPolicy

Methods inherited from class PamguardMVC.PamDataBlock

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

Methods inherited from class PamguardMVC.PamObservable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ClickTrainDataBlock

public ClickTrainDataBlock(ClickTrainControl clickTrainControl,
 PamProcess parentProcess,
 String name,
 int channelMap)

Method Details

saveViewerData

public boolean saveViewerData()

Description copied from class: PamDataBlock

Saves data in this data block in offline viewer mode.

Overrides:

saveViewerData in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Returns:

true if data found and saved.

loadViewerData

public boolean loadViewerData(OfflineDataLoadInfo offlineDataLoadInfo,
 ViewLoadObserver loadObserver)

Description copied from class: PamDataBlock

Instruction from the viewer scroll manager to load new data.

Overrides:

loadViewerData in class PamDataBlock<T extends CTDetectionGroupDataUnit>

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.

addPamData

public void addPamData(T pamDataUnit)

Description copied from class: PamDataBlock

Adds a new PamDataUnit to the PamDataBlock. When the data unit is added, PamObservers that have subscribed to the block will be notified.
If the data unit already has a UID, it will be left as is.

Overrides:

addPamData in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Parameters:

pamDataUnit - Reference to a PamDataUnit

addPamData

public void addPamData(T pamDataUnit,
 Long uid)

Description copied from class: PamDataBlock

Adds a new PamDataUnit to the PamDataBlock and force the UID to a specific value. This should only be used in very specific circumstances - nromally, programmers should call addPamData(Tunit pamDataUnit) and let PAMGuard handle the UID's.

Overrides:

addPamData in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Parameters:

pamDataUnit - Reference to a PamDataUnit

uid - Unique identifier for data unit.

updatePamData

public void updatePamData(T pamDataUnit,
 long updateTimeMillis)

Description copied from class: PamDataBlock

update a dataunit. Does little except flag that the data unit is updated (so it will get saved), and sends notifications to other modules.

Overrides:

updatePamData in class PamDataBlock<T extends CTDetectionGroupDataUnit>

getSampleRate

public float getSampleRate()

Overrides:

getSampleRate in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Returns:

The sample rate of the data contained in the block

needViewerDataLoad

public boolean needViewerDataLoad(OfflineDataLoadInfo offlineDataLoadInfo)

Description copied from class: PamDataBlock

Do we need to reload offline data ? Default behaviour is to reurn true if the time periods of the data load have changed, false otherwise.

Overrides:

needViewerDataLoad in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Returns:

true if we need to reload offline data.

shouldNotify

public boolean shouldNotify()

Overrides:

shouldNotify in class PamDataBlock<T extends CTDetectionGroupDataUnit>

getClickTrainControl

public ClickTrainControl getClickTrainControl()

Get the click train control.

Returns:

the click train control.

getDataSelectCreator

public DataSelectorCreator getDataSelectCreator()

Overrides:

getDataSelectCreator in class PamDataBlock<T extends CTDetectionGroupDataUnit>

Returns:

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