clickDetector.offlineFuncs

Class OfflineEventDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

PamDetection.AcousticDataUnit

PamDetection.PamDetection<ClickDetection,PamDetection>

clickDetector.offlineFuncs.OfflineEventDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

public class OfflineEventDataUnit
extends PamDetection<ClickDetection,PamDetection>

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.

Author:

Doug Gillespie

Field Summary

Fields inherited from class PamDetection.AcousticDataUnit

AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Constructor Summary

Constructors

Constructor and Description
OfflineEventDataUnit(java.lang.String eventType, java.lang.Integer colourIndex, ClickDetection firstClick)

Method Summary

Methods

Modifier and Type	Method and Description
void	addClicks(java.util.List<ClickDetection> markedClicks) Add a list of clicks to an event.
int	addSubDetection(ClickDetection subDetection) Add a new click to the event.
void	addSubDetection(ClickDetection subDetection, boolean countClick) Add a sub detection with the option of not increasing the click count.
ClickDetection	findSubDetection(long timeMillis, long startSample, int channelBitmap)
java.lang.Short	getBestNumber()
short	getColourIndex()
java.lang.String	getComment()
int	getEventNumber()
java.lang.String	getEventType()
java.lang.Short	getMaxNumber()
java.lang.Short	getMinNumber()
int	getNClicks()
boolean	isSuspectEventTimes()
void	notifyUpdate() Quick way for events to tell observers of the data block that they have updated.
void	removeSubDetection(ClickDetection subDetection)
void	setBestNumber(java.lang.Short bestNumber)
void	setComment(java.lang.String comment)
void	setEventType(java.lang.String eventType)
void	setMaxNumber(java.lang.Short maxNumber)
void	setMinNumber(java.lang.Short minNumber)
void	setNClicks(int nClicks)
void	setSuspectEventTimes(boolean suspectEventTimes)

Methods inherited from class PamDetection.PamDetection

addSuperDetection, findSubDetection, getDetectionType, getEventEndTime, getPeakTime, getSubDetection, getSubDetectionsCount, getSubDetectionSyncronisation, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, removeSuperDetection, replaceSubDetection, setDetectionType, setEventEndTime, setPeakTime, setUniqueSuperDetection

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

OfflineEventDataUnit

public OfflineEventDataUnit(java.lang.String eventType,
                    java.lang.Integer colourIndex,
                    ClickDetection firstClick)

Method Detail

addClicks

public void addClicks(java.util.List<ClickDetection> markedClicks)

Add a list of clicks to an event.

Parameters:

markedClicks - List of marked clicks.

addSubDetection

public void addSubDetection(ClickDetection subDetection,
                   boolean countClick)

Add a sub detection with the option of not increasing the click count. This is used when setting up data as it's read from the database, not when adding new clicks under normal operation

Parameters:

subDetection - click to add to event

countClick - true if click count should be increased.

addSubDetection

public int addSubDetection(ClickDetection subDetection)

Add a new click to the event. As each click is added, some checks are done to make sure that the click is not already part of some other event, and if all events are removed from some other event, make sure that that other event get's deleted.

Overrides:

addSubDetection in class PamDetection<ClickDetection,PamDetection>

Parameters:

subDetection - a new click to add.

findSubDetection

public ClickDetection findSubDetection(long timeMillis,
                              long startSample,
                              int channelBitmap)

removeSubDetection

public void removeSubDetection(ClickDetection subDetection)

Overrides:

removeSubDetection in class PamDetection<ClickDetection,PamDetection>

getEventType

public java.lang.String getEventType()

Returns:

the eventType

getColourIndex

public short getColourIndex()

setEventType

public void setEventType(java.lang.String eventType)

Parameters:

eventType - the eventType to set

getComment

public java.lang.String getComment()

Returns:

the comment

setComment

public void setComment(java.lang.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 java.lang.Short getMinNumber()

setMinNumber

public void setMinNumber(java.lang.Short minNumber)

getBestNumber

public java.lang.Short getBestNumber()

setBestNumber

public void setBestNumber(java.lang.Short bestNumber)

getMaxNumber

public java.lang.Short getMaxNumber()

setMaxNumber

public void setMaxNumber(java.lang.Short maxNumber)

getNClicks

public int getNClicks()

setNClicks

public void setNClicks(int nClicks)

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.