Package gpl

Class GPLDetection

java.lang.Object

PamguardMVC.PamDataUnit

gpl.GPLDetection

All Implemented Interfaces:

Comparable, PamDetection, AcousticDataUnit, TFContourProvider

public class GPLDetection
extends PamDataUnit
implements AcousticDataUnit, PamDetection, TFContourProvider

Field Summary

Fields inherited from class PamguardMVC.PamDataUnit

absBlockIndex, localisation

Constructor Summary

Constructors

Constructor	Description
GPLDetection(long timeMilliseconds, int channelBitmap, long startSample, long durationSamples, double timeRes, double freqRes, GPLContour aContour)
GPLDetection(DataUnitBaseData basicData, double timeRes, double freqRes, GPLContour aContour)

Method Summary

Modifier and Type	Method	Description
GPLContour	getContour()
double	getFreqRes()
double	getPeakValue()
TFContourData	getTFContourData()	Gets time-frequency contour information in units of milliseconds and frequency
double	getTimeRes()
void	setPeakValue(double peakValue)

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

GPLDetection

public GPLDetection(long timeMilliseconds,
 int channelBitmap,
 long startSample,
 long durationSamples,
 double timeRes,
 double freqRes,
 GPLContour aContour)

GPLDetection

public GPLDetection(DataUnitBaseData basicData,
 double timeRes,
 double freqRes,
 GPLContour aContour)

Method Details

getPeakValue

public double getPeakValue()

Returns:

the peakValue

setPeakValue

public void setPeakValue(double peakValue)

Parameters:

peakValue - the peakValue to set

getContour

public GPLContour getContour()

Returns:

the contour

getTimeRes

public double getTimeRes()

Returns:

the timeRes

getFreqRes

public double getFreqRes()

Returns:

the freqRes

getTFContourData

public TFContourData getTFContourData()

Description copied from interface: TFContourProvider

Gets time-frequency contour information in units of milliseconds and frequency

Specified by:

getTFContourData in interface TFContourProvider

Returns:

TFContour data object.