Package rawDeepLearningClassifier.dlClassification

Class DLDetection

java.lang.Object

PamguardMVC.PamDataUnit<PamDataUnit,SuperDetection>

clipgenerator.ClipDataUnit

rawDeepLearningClassifier.dlClassification.DLDetection

All Implemented Interfaces:

Comparable<PamDataUnit>, PamDetection, AcousticDataUnit, RawDataHolder

public class DLDetection
extends ClipDataUnit
implements PamDetection, RawDataHolder

A detected DL data unit. These data units are only ever generated from raw sound data from the segmenter. Otherwise DL results are saved as annotations on other data units.

Author:

Jamie Macaulay

Field Summary

Fields inherited from class clipgenerator.ClipDataUnit

fastFFT, fileName, triggerMilliseconds, triggerName

Fields inherited from class PamguardMVC.PamDataUnit

absBlockIndex

Constructor Summary

Constructors

Constructor	Description
DLDetection(long timeMilliseconds, int channelBitmap, long startSample, long durationSamples, ArrayList<PredictionResult> modelResults, double[][] waveData, float sampleRate)	Deprecated.
DLDetection(DataUnitBaseData baseData, double[][] waveData, float sampleRate)	Create a data unit for DL which has passed binary classification.

Method Summary

Modifier and Type	Method	Description
void	addDataAnnotation(DataAnnotation dataAnnotation)	Adds a data annotation to the data unit.
RawDataTransforms	getDataTransforms()	Get the raw data transforms class.
AbstractLocalisation	getLocalisation()
ArrayList<PredictionResult>	getModelResults()	Get the model results that were used to construct the data unit.
double[][]	getPowerSpectrum(int fftLength)	Get the power spectrum for all channels.
ClipSpectrogram	getSpectrogram(int fftSize, int fftHop)	Get a spectrogram image of the wave clip.
double[][]	getWaveData()	Get all the wave data into an array.
double[]	getWaveData(int channel)	Get the wave data for a specified channel.

Methods inherited from class clipgenerator.ClipDataUnit

clearClipSpecData, findTriggerDataUnit, generateComplexSpectrogram, generateSpectrogramArrays, getClipImage, getDisplaySampleRate, getFastFFT, getRawData, getSampleRate, getSourceSampleRate, getSpectrogramData, getSpectrogramWaveData, getSummaryString, getTriggerDataUnit, getTriggerMilliseconds, getTriggerUID, getWindowFunc, getWindowType, setRawData, setTimeMilliseconds, setTriggerDataUnit, setTriggerUID, setWindowType

Methods inherited from class PamguardMVC.PamDataUnit

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, getMeasuredAmplitude, getMeasuredAmplitudeType, getNoiseBackground, getNumDataAnnotations, getOriginLatLong, getParentDataBlock, getSampleDuration, getSampleDurationAsInt, getSeconds, getSequenceBitmap, getSequenceBitmapObject, getSignalExcess, getSignalSPL, getSnapshotGeometry, getStartSample, 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, setUID, setUniqueSuperDetection, sortOutputMaps, updateDataUnit

Methods inherited from class java.lang.Object

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

Constructor Details

DLDetection

@Deprecated
public DLDetection(long timeMilliseconds,
 int channelBitmap,
 long startSample,
 long durationSamples,
 ArrayList<PredictionResult> modelResults,
 double[][] waveData,
 float sampleRate)

Deprecated.

Create a data unit for DL which has passed binary classification.

Parameters:

timeMilliseconds - - the time in milliseconds.

channelBitmap - - the channel bit map.

startSample - - the start sample.

durationSamples - - the duration in samples.

modelResults - - the model results that were used to construct the data unit.

DLDetection

public DLDetection(DataUnitBaseData baseData,
 double[][] waveData,
 float sampleRate)

Create a data unit for DL which has passed binary classification. Usually used for loading data units from binary files.

Parameters:

baseData - - the base binary data.

waveData - - the wave data.

probdata - - the probability data.

Method Details

addDataAnnotation

public void addDataAnnotation(DataAnnotation dataAnnotation)

Description copied from class: PamDataUnit

Adds a data annotation to the data unit. Removes any existing annotation of the same type and name.

Overrides:

addDataAnnotation in class PamDataUnit<PamDataUnit,SuperDetection>

Parameters:

dataAnnotation - data annotation

getLocalisation

public AbstractLocalisation getLocalisation()

Overrides:

getLocalisation in class ClipDataUnit

Returns:

Returns the localisation.

getWaveData

public double[][] getWaveData()

Description copied from class: ClipDataUnit

Get all the wave data into an array.

Specified by:

getWaveData in interface RawDataHolder

Overrides:

getWaveData in class ClipDataUnit

Returns:

the wave data or null if it can't be found.

getModelResults

public ArrayList<PredictionResult> getModelResults()

Get the model results that were used to construct the data unit. The number of results will generally be the raw data length divided by hop size.

Returns:

the model results.

getWaveData

public double[] getWaveData(int channel)

Get the wave data for a specified channel.

Overrides:

getWaveData in class ClipDataUnit

Parameters:

channel -

Returns:

getSpectrogram

public ClipSpectrogram getSpectrogram(int fftSize,
 int fftHop)

Get a spectrogram image of the wave clip. The clip is null until called. It is recalculated if the FFT length and/or hop size are different.

Parameters:

fftSize - - the FFT size in samples

fftHop - - the FFT hop in samples

Returns:

a spectrogram clip (dB/Hz ).

getPowerSpectrum

public double[][] getPowerSpectrum(int fftLength)

Get the power spectrum for all channels.

Parameters:

fftLength - - the fft length to use.

Returns:

the power sepctrums for all channels.

getDataTransforms

public RawDataTransforms getDataTransforms()

Description copied from interface: RawDataHolder

Get the raw data transforms class. This handles standard data transforms that are often used in raw data units, e.g. calculating the spectrum, filtering waveforms, getting data as an int16 (short) array, etc.

Specified by:

getDataTransforms in interface RawDataHolder

Overrides:

getDataTransforms in class ClipDataUnit

Returns:

the data transforms object.