Package clickDetector.offlineFuncs

Class OfflineEventDataUnit

java.lang.Object

PamguardMVC.PamDataUnit<T,SuperDetection>

PamguardMVC.superdet.SuperDetection<T>

Localiser.detectionGroupLocaliser.GroupDetection<PamDataUnit>

clickDetector.offlineFuncs.OfflineEventDataUnit

All Implemented Interfaces:

Comparable<PamDataUnit>, PamDetection, AcousticDataUnit

Direct Known Subclasses:

ClickTrainDetection

public class OfflineEventDataUnit
extends GroupDetection<PamDataUnit>

OfflineEventDataUnit replicates the RainbowClick functionality in OfflineRCEvent.

A lot of the functionality required to associate clicks with an event is already wrapped up in the base classes of PamDataBlock and PamDataUnit.

March 2016. Am merging online and offline click tracking functionality, so this has now been declared abstract to stop them being created directly and TrackedClickGroup has been made to subclass this, so that both now have the same functionality. May at a later date remove trackedclickGroup and go back to just having the one class of OfflineEventDataUnit - or better, EventDataUnit.

Author:

Doug Gillespie

Field Summary

Fields inherited from class Localiser.detectionGroupLocaliser.GroupDetection

STATUS_CLOSED, STATUS_OPEN

Constructor Summary

Constructors

Constructor	Description
OfflineEventDataUnit(long timeMilliseconds, int channelBitmap, long startSample, long duration)
OfflineEventDataUnit(ClickDetection firstClick)
OfflineEventDataUnit(String eventType, Integer nominalEventId, ClickDetection firstClick)	Called whena new event is created.

Method Summary

Modifier and Type	Method	Description
Short	getBestNumber()
int	getColourIndex()	Get a colour id.
String	getComment()
int	getEventNumber()
String	getEventType()
Short	getMaxNumber()
Short	getMinNumber()
int	getNClicks()
boolean	isSuspectEventTimes()
void	notifyUpdate()	Quick way for events to tell observers of the data block that they have updated.
void	setBestNumber(Short bestNumber)
void	setColourIndex(int colourIndex)
void	setComment(String comment)
void	setEventType(String eventType)
void	setMaxNumber(Short maxNumber)
void	setMinNumber(Short minNumber)
void	setSuspectEventTimes(boolean suspectEventTimes)

Methods inherited from class Localiser.detectionGroupLocaliser.GroupDetection

addFitData, addSubDetection, getEventEndTime, getEventId, getGroupDetectionLocalisation, getPredictedBearing, getStatus, makeLocalisation, setEventEndTime, setEventId, setStatus

Methods inherited from class PamguardMVC.superdet.SuperDetection

addSubDetectionInfo, addSubDetections, clearSubDetectionData, clearSubDetectionObjects, clearSubdetectionsRemoved, findSubDetection, findSubDetection, findSubDetection, findSubdetectionInfo, findSubDetectionInfo, getLoadedSubDetectionsCount, getPresentSubDetections, getSubDetection, getSubdetectionInfo, getSubDetectionInfo, getSubDetections, getSubDetectionsCount, getSubdetectionsRemoved, getSubDetectionSyncronisation, isAllowSubdetectionSharing, removeAllSubDetections, removeSubDetection, replaceSubDetection, sortSubDetections

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, addSuperDetection, amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, calcSnapshotGeometry, clearOandAngles, clearUpdateCount, compareTo, findDataAnnotation, findDataAnnotation, freeData, getAbsBlockIndex, getAmplitudeDB, getAnnotationsSummaryString, getBasicData, getCalculatedAmlitudeDB, getChannelBitmap, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDataUnitPopupMenu, getDurationInMilliseconds, getEndTimeInMilliseconds, getFrequency, getFrequencyOverlap, getHydrophoneBitmap, getHydrophoneHeading, getLastChangeTime, getLastSample, getLastUpdateTime, getLocalisation, getMeasuredAmplitude, getMeasuredAmplitudeType, getNoiseBackground, getNumDataAnnotations, getOriginLatLong, getParentDataBlock, getSampleDuration, getSampleDurationAsInt, getSeconds, getSequenceBitmap, getSequenceBitmapObject, getSignalExcess, getSignalSPL, getSnapshotGeometry, getStartSample, getSummaryString, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, getSuperId, getTimeDelaysSeconds, getTimeMilliseconds, getTimeNanoseconds, getTimeOverlap, getUID, getUpdateCount, isEmbryonic, isForceAmpRecalc, linAmplitudeToDB, removeDataAnnotation, removeDataAnnotation, removeSuperDetection, setAbsBlockIndex, setCalculatedAmlitudeDB, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setDurationInMilliseconds, setEmbryonic, setForceAmpRecalc, setFrequency, setInfo, setLastUpdateTime, setLocalisation, setMeasuredAmpAndType, setMeasuredAmplitude, setMeasuredAmplitudeType, setNoiseBackground, setParentDataBlock, setSampleDuration, setSequenceBitmap, setSignalExcess, setSignalSPL, setSnapshotGeometry, setStartSample, setTimeDelaysSeconds, setTimeMilliseconds, setUID, setUniqueSuperDetection, sortOutputMaps, updateDataUnit

Methods inherited from class java.lang.Object

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

Constructor Details

OfflineEventDataUnit

public OfflineEventDataUnit(ClickDetection firstClick)

OfflineEventDataUnit

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

OfflineEventDataUnit

public OfflineEventDataUnit(String eventType,
 Integer nominalEventId,
 ClickDetection firstClick)

Called whena new event is created.

Parameters:

eventType -

firstClick -

colourIndex -

Method Details

getEventType

public String getEventType()

Returns:

the eventType

getColourIndex

public int getColourIndex()

Description copied from class: PamDataUnit

Get a colour id. this can be pretty much anything and will be scaled, looped, to fit in the range of whale id colours. Mostly used for superdetection display, but can be used by anything.

Overrides:

getColourIndex in class PamDataUnit<PamDataUnit,SuperDetection>

Returns:

any integer.

setColourIndex

public void setColourIndex(int colourIndex)

setEventType

public void setEventType(String eventType)

Parameters:

eventType - the eventType to set

getComment

public String getComment()

Returns:

the comment

setComment

public void setComment(String comment)

Parameters:

comment - the comment to set

getEventNumber

public int getEventNumber()

Returns:

the eventNumber which is the same as the database index.

getMinNumber

public Short getMinNumber()

setMinNumber

public void setMinNumber(Short minNumber)

getBestNumber

public Short getBestNumber()

setBestNumber

public void setBestNumber(Short bestNumber)

getMaxNumber

public Short getMaxNumber()

setMaxNumber

public void setMaxNumber(Short maxNumber)

getNClicks

public int getNClicks()

isSuspectEventTimes

public boolean isSuspectEventTimes()

Returns:

the suspectEventTimes

setSuspectEventTimes

public void setSuspectEventTimes(boolean suspectEventTimes)

Parameters:

suspectEventTimes - the suspectEventTimes to set

notifyUpdate

public void notifyUpdate()

Quick way for events to tell observers of the data block that they have updated.