PamDetection

Class PamDetection<T extends PamDetection,U extends PamDetection>

java.lang.Object

PamguardMVC.PamDataUnit

PamDetection.AcousticDataUnit

PamDetection.PamDetection<T,U>

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

Direct Known Subclasses:

AbstractWhistleDataUnit, ClickDetection, ClipDataUnit, ClipSpectrogramMark, EventDataUnit, GroupDetDataUnit, GroupDetection, IshAnchorGroup, IshDetection, IshDetWrapper, IshTrack, OfflineEventDataUnit, PamLocalisation, PeakDataUnit, RoccaContourDataUnit, RoccaDataUnit, RoccaSightingDataUnit, ThresholdDetectorDataUnit, TowedArray3DDataUnit, TriggerLevelDataUnit, VetoDataUnit, WorkshopDataUnit, XBatLogDataUnit

public class PamDetection<T extends PamDetection,U extends PamDetection>
extends AcousticDataUnit

Base class for all Pamguard detections. Hopefully, we'll be able to subclass this off to become more specific for various other detection types.

These things will nearly always be stored within a PamDataUnit which already contains some of the information - such as the channelMap - should this be repeated here ?

One thing this will have to do is to deal with the myriad of different amplitude types. I suggest that the basic storage unit should either be fft amplitude units - which will be there for any detection that comes out of a spectrogram, or peak ADC values, such as would come from a click detector. The class will have functions for converting between the different amplitude types.

Author:

Doug Gillespie

Field Summary

Fields inherited from class PamDetection.AcousticDataUnit

AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Constructor Summary

Constructors

Constructor and Description
PamDetection(long timeMilliseconds, int channelBitmap, long startSample, long duration)

Method Summary

Methods

Modifier and Type	Method and Description
int	addSubDetection(T subDetection) Add a sub detection to the sub detection list.
void	addSuperDetection(U superDetection)
T	findSubDetection(long timeMillis, int channelBitmap) find a sub detection based on it's time and it's channel map
java.lang.String	getDetectionType()
long	getEventEndTime()
double	getPeakTime()
T	getSubDetection(int ind)
int	getSubDetectionsCount()
java.lang.Object	getSubDetectionSyncronisation()
U	getSuperDetection(java.lang.Class superClass)
U	getSuperDetection(int ind)
int	getSuperDetectionsCount()
java.lang.Object	getSuperDetectionSyncronisation()
void	removeSubDetection(T subDetection)
void	removeSuperDetection(U superDetection)
void	replaceSubDetection(T oldOne, T newOne) Replace a sub detection in an event.
void	setDetectionType(java.lang.String detectionType)
void	setEventEndTime(long eventEndTime)
void	setPeakTime(double peakTimeMsec)
int	setUniqueSuperDetection(U superDetection) Sets a unique super detection.

Methods inherited from class PamDetection.AcousticDataUnit

amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, compareTo, getAmplitudeDB, getCalculatedAmlitudeDB, getDuration, getFrequency, getFrequencyOverlap, getLastSample, getMeasuredAmplitude, getMeasuredAmplitudeType, getSeconds, getStartSample, getSummaryString, getTimeOverlap, setCalculatedAmlitudeDB, setDuration, setFrequency, setInfo, setMeasuredAmplitude, setMeasuredAmplitude, setMeasuredAmplitudeType, setStartSample

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, clearOandAngles, clearUpdateCount, findDataAnnotation, getAbsBlockIndex, getChannelBitmap, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDetectionMatch, getDetectionMatch, getHydrophoneHeading, getLastUpdateTime, getLocalisation, getNumDataAnnotations, getOriginLatLong, getPairAngle, getParentDataBlock, getTimeMilliseconds, getUpdateCount, removeDataAnnotation, removeDataAnnotation, setAbsBlockIndex, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setLastUpdateTime, setLocalisation, setOriginLatLong, setParentDataBlock, setTimeMilliseconds, updateDataUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

PamDetection

public PamDetection(long timeMilliseconds,
            int channelBitmap,
            long startSample,
            long duration)

Method Detail

getPeakTime

public double getPeakTime()

Returns:

Returns the peakTime, in msec. relative to the start of the PAMGUARD run

setPeakTime

public void setPeakTime(double peakTimeMsec)

Parameters:

peakTimeMsec - The peakTime to set, in msec. relative to the start of the PAMGUARD run.

getDetectionType

public java.lang.String getDetectionType()

Returns:

Returns the detectionType.

setDetectionType

public void setDetectionType(java.lang.String detectionType)

Parameters:

detectionType - The detectionType to set.

addSubDetection

public int addSubDetection(T subDetection)

Add a sub detection to the sub detection list.

Parameters:

subDetection -

setUniqueSuperDetection

public int setUniqueSuperDetection(U superDetection)

Sets a unique super detection. i.e. if the data unit already had a super detection of the same class, then this data unit is removed from that pre-existing superdetection.

Parameters:

superDetection -

addSuperDetection

public void addSuperDetection(U superDetection)

findSubDetection

public T findSubDetection(long timeMillis,
                 int channelBitmap)

find a sub detection based on it's time and it's channel map

Parameters:

timeMillis - time in milliseconds

channelBitmap - channel map

Returns:

found sub detection, or null if none exists.

replaceSubDetection

public void replaceSubDetection(T oldOne,
                       T newOne)

Replace a sub detection in an event.

if the original sub detection does not exist, then the new one is added anyway.

Parameters:

oldOne - old sub detection

newOne - new sub detection.

getSubDetectionsCount

public int getSubDetectionsCount()

getSuperDetectionsCount

public int getSuperDetectionsCount()

getSubDetection

public T getSubDetection(int ind)

getSuperDetection

public U getSuperDetection(java.lang.Class superClass)

getSuperDetection

public U getSuperDetection(int ind)

removeSubDetection

public void removeSubDetection(T subDetection)

removeSuperDetection

public void removeSuperDetection(U superDetection)

getSubDetectionSyncronisation

public java.lang.Object getSubDetectionSyncronisation()

getSuperDetectionSyncronisation

public java.lang.Object getSuperDetectionSyncronisation()

setEventEndTime

public void setEventEndTime(long eventEndTime)

getEventEndTime

public long getEventEndTime()