Package clickTrainDetector

Class CTDetectionGroupDataUnit

java.lang.Object

PamguardMVC.PamDataUnit<PamDataUnit,SuperDetection>

PamguardMVC.superdet.SuperDetection<PamDataUnit>

detectiongrouplocaliser.DetectionGroupDataUnit

clickTrainDetector.CTDetectionGroupDataUnit

All Implemented Interfaces:

Comparable<PamDataUnit>, PamDetection, AcousticDataUnit

Direct Known Subclasses:

CTDataUnit, TempCTDataUnit

public abstract class CTDetectionGroupDataUnit
extends DetectionGroupDataUnit
implements PamDetection

Base class for a click train data unit. Note this must implrement PamDetection to work with the clip generator.

Author:

Jamie Macaulay

Field Summary

Fields inherited from class PamguardMVC.PamDataUnit

absBlockIndex, localisation

Constructor Summary

Constructors

Constructor	Description
CTDetectionGroupDataUnit(long timeMilliseconds, List<PamDataUnit> list)

Method Summary

Modifier and Type	Method	Description
int	addSubDetections(List<PamDataUnit> list)	Add multiple sub detections from a list.
void	calcMinMaxAng()	Calculate the minimum and maximum angle of the whole click train.
void	calcStartSample()	Calculate a valid start sample.
void	calcSummaryUnits(CTSelectParams ctDataUnitParams)	Update the data unit list.
void	clearSummaryDataUnits()	Clear data units from the summary list
double	getAngleRange()	Get the angle range in RADIANS.
ArrayList<PamDataUnit>	getSummaryUnits()	Get the summary data units from the last calculation.

Methods inherited from class PamguardMVC.superdet.SuperDetection

addSubDetection, addSubDetectionInfo, 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, getColourIndex, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDataUnitPopupMenu, getDurationInMilliseconds, getEndTimeInMilliseconds, getFrequency, getFrequencyOverlap, getGpsPosition, 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

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

Constructor Details

CTDetectionGroupDataUnit

public CTDetectionGroupDataUnit(long timeMilliseconds,
 List<PamDataUnit> list)

Method Details

addSubDetections

public int addSubDetections(List<PamDataUnit> list)

Description copied from class: SuperDetection

Add multiple sub detections from a list.

Overrides:

addSubDetections in class SuperDetection<PamDataUnit>

Parameters:

list - List of new sub detections

Returns:

total number of sub detections now in the super detection

calcStartSample

public void calcStartSample()

Calculate a valid start sample. This is important for the clip generator.

calcSummaryUnits

public void calcSummaryUnits(CTSelectParams ctDataUnitParams)

Update the data unit list. The summary data units are used to represent a click train with a sub set of data units; usually this is for plotting purposes but could also be used for sending data where bandwidth is limited e.g. satellite or 4G.

Parameters:

ctDataUnit - the data unit list.

calcMinMaxAng

public void calcMinMaxAng()

Calculate the minimum and maximum angle of the whole click train.

clearSummaryDataUnits

public void clearSummaryDataUnits()

Clear data units from the summary list

getSummaryUnits

public ArrayList<PamDataUnit> getSummaryUnits()

Get the summary data units from the last calculation.

Returns:

summary data units.

getAngleRange

public double getAngleRange()

Get the angle range in RADIANS.

Returns:

the angle range.