Package IshmaelDetector

Class IshDetection

java.lang.Object

PamguardMVC.PamDataUnit<PamDataUnit,SuperDetection>

IshmaelDetector.IshDetection

All Implemented Interfaces:

Comparable<PamDataUnit>, PamDetection, AcousticDataUnit

public class IshDetection
extends PamDataUnit<PamDataUnit,SuperDetection>
implements PamDetection

Basic detection on a single channel for the Ishmael det/loc.

Note that the Ishmael detection does not contain raw wav data - this is intentional as the clip generator can be used to generate clips if required. As the Ishmael detector is a high false positive rate intial detection stage then it may very well be beneficial not to store clips but simply pass the raw data to downstream processes.

Author:

Doug Gillespie, Jamie Macaulay and Dave Mellinger

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
IshDetection(long startMsec, long endMsec, float lowFreq, float highFreq, long peakTimeSam, double peakHeight, PamDataBlock parentDataBlock, int channelBitmap, long startSam, long durationSam)
IshDetection(DataUnitBaseData baseData, long peakTimeSample, double peakHeight)

Method Summary

Modifier and Type	Method	Description
String	getCallType()
double	getPeakDelaySec()
double	getPeakHeight()
double	getPeakTimeSam()
String	getSummaryString()	Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
void	setCallType(String callType)
void	setInfo(long startMsec, int channelBitmap, long startSam, long durationSam, float lowFreq, float highFreq, long peakTimeSam, double peakHeight)	Set various parameters.
void	setPeakDelaySec(double peakDelaySec)
void	setPeakHeight(double peakHeight)
void	setPeakTimeSam(double peakTimeSam)

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, getHydrophoneBitmap, getHydrophoneHeading, getLastChangeTime, getLastSample, getLastUpdateTime, getLocalisation, 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, setTimeMilliseconds, setUID, setUniqueSuperDetection, sortOutputMaps, updateDataUnit

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

public static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

IshDetection

public IshDetection(long startMsec,
 long endMsec,
 float lowFreq,
 float highFreq,
 long peakTimeSam,
 double peakHeight,
 PamDataBlock parentDataBlock,
 int channelBitmap,
 long startSam,
 long durationSam)

IshDetection

public IshDetection(DataUnitBaseData baseData,
 long peakTimeSample,
 double peakHeight)

Method Details

getCallType

public String getCallType()

setCallType

public void setCallType(String callType)

getPeakDelaySec

public double getPeakDelaySec()

getPeakHeight

public double getPeakHeight()

getPeakTimeSam

public double getPeakTimeSam()

setPeakDelaySec

public void setPeakDelaySec(double peakDelaySec)

setPeakHeight

public void setPeakHeight(double peakHeight)

setPeakTimeSam

public void setPeakTimeSam(double peakTimeSam)

setInfo

public void setInfo(long startMsec,
 int channelBitmap,
 long startSam,
 long durationSam,
 float lowFreq,
 float highFreq,
 long peakTimeSam,
 double peakHeight)

Set various parameters.

Parameters:

startMsec -

channelBitmap -

startSam - relative to start of PAMGUARD run

durationSam -

lowFreq - lower edge of call T/F box, Hz

highFreq - upper edge of call T/F box, Hz

peakTimeSam - relative to start of PAMGUARD run

peakHeight - measure of detection quality; different detectors will scale it differently, so it's only comparable within a detector type

getSummaryString

public String getSummaryString()

Description copied from class: PamDataUnit

Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.

Overrides:

getSummaryString in class PamDataUnit<PamDataUnit,SuperDetection>

Returns:

summary string