Package qa

Class QASoundDataUnit

java.lang.Object

PamguardMVC.PamDataUnit<T,SuperDetection>

PamguardMVC.superdet.SuperDetection<T>

qa.QADataUnit

qa.QASoundDataUnit

All Implemented Interfaces:

Comparable, AcousticDataUnit

public class QASoundDataUnit
extends QADataUnit
implements AcousticDataUnit

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SOUND_COMPLETE
static final int	SOUND_GENERATING
static final int	SOUND_NOT_STARTED

Constructor Summary

Constructors

Constructor	Description
QASoundDataUnit(SoundSequence soundSequence, SequenceData sequenceData, long timeMilliseconds, int channelBitmap, long startSample, QASound qaSound, double receivedLevel)

Method Summary

Modifier and Type	Method	Description
long	getArrivalEndMillis()
long	getArrivalStartMillis()
int	getDetectorHit(PamDataBlock dataBlock)	Get whether or not this simulated data has been detected by a particular detector.
Double	getDistanceToAirgun()
Double	getDistanceToHydrophone()
long	getFirstSample()
long	getLastSample()	get the last sample number in the data unit
int	getMultiPath()
int	getNumDetectorHits()
double	getReceivedLevel()
LatLong	getReferenceLatLong()
SequenceData	getSequenceData()
SoundSequence	getSoundSequence()
LatLong	getSourceLatLong()
QASound	getStandardSound()
int	getState()
void	setArrivalEndMillis(long arrivalEndMillis)
void	setArrivalMillis(long arrivalStartMillis, long arrivalEndMillis)
void	setArrivalStartMillis(long arrivalStartMillis)
boolean	setDetectorHit(PamDataBlock dataBlock, int channelMap)	Set 'hit' status for a detector.
boolean	setDetectorHit(PamDataBlock dataBlock, PamDataUnit detection)	Set 'hit' status for a detector.
void	setDistanceToAirgun(Double distanceToAirgun)
void	setDistanceToHydrophone(Double distanceToHydrophone)
void	setMultiPath(int multiPath)
void	setState(int state)
String	toString()

Methods inherited from class qa.QADataUnit

getQaOpsDataUnit, setQaOpsDataUnit

Methods inherited from class PamguardMVC.superdet.SuperDetection

addSubDetection, addSubDetectionInfo, addSubDetections, 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, getHydrophoneBitmap, getHydrophoneHeading, getLastChangeTime, 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

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

Field Details

SOUND_NOT_STARTED

public static final int SOUND_NOT_STARTED

See Also:

• Constant Field Values

SOUND_GENERATING

public static final int SOUND_GENERATING

See Also:

• Constant Field Values

SOUND_COMPLETE

public static final int SOUND_COMPLETE

See Also:

• Constant Field Values

Constructor Details

QASoundDataUnit

public QASoundDataUnit(SoundSequence soundSequence,
 SequenceData sequenceData,
 long timeMilliseconds,
 int channelBitmap,
 long startSample,
 QASound qaSound,
 double receivedLevel)

Method Details

getStandardSound

public QASound getStandardSound()

Returns:

the standardSound

getState

public int getState()

Returns:

the state

setState

public void setState(int state)

Parameters:

state - the state to set

getMultiPath

public int getMultiPath()

Returns:

the multiPath

setMultiPath

public void setMultiPath(int multiPath)

Parameters:

multiPath - the multiPath to set

getFirstSample

public long getFirstSample()

Returns:

the firstSample

getLastSample

public long getLastSample()

Description copied from class: PamDataUnit

get the last sample number in the data unit

Overrides:

getLastSample in class PamDataUnit

Returns:

the lastSample

setArrivalMillis

public void setArrivalMillis(long arrivalStartMillis,
 long arrivalEndMillis)

getArrivalStartMillis

public long getArrivalStartMillis()

Returns:

the arrivalStartMillis

setArrivalStartMillis

public void setArrivalStartMillis(long arrivalStartMillis)

Parameters:

arrivalStartMillis - the arrivalStartMillis to set

getArrivalEndMillis

public long getArrivalEndMillis()

Returns:

the arrivalEndMillis

setArrivalEndMillis

public void setArrivalEndMillis(long arrivalEndMillis)

Parameters:

arrivalEndMillis - the arrivalEndMillis to set

setDetectorHit

public boolean setDetectorHit(PamDataBlock dataBlock,
 PamDataUnit detection)

Set 'hit' status for a detector.

Parameters:

dataBlock - datablock containing the detection

detection - detection data unit.

Returns:

true if the underlying data were updated. false if they remained the same.

setDetectorHit

public boolean setDetectorHit(PamDataBlock dataBlock,
 int channelMap)

Set 'hit' status for a detector.

Parameters:

dataBlock - datablock containing the detection

channelMap - detection channel map.

Returns:

true if the underlying data were updated. false if they remained the same.

getDetectorHit

public int getDetectorHit(PamDataBlock dataBlock)

Get whether or not this simulated data has been detected by a particular detector.

Parameters:

dataBlock - datablock for the detector

Returns:

0 if no detection, otherwise the UID of the detection.

getNumDetectorHits

public int getNumDetectorHits()

getSourceLatLong

public LatLong getSourceLatLong()

Returns:

the latLong

getReferenceLatLong

public LatLong getReferenceLatLong()

Returns:

the referenceLatLong

getSoundSequence

public SoundSequence getSoundSequence()

Returns:

the soundSequence

getSequenceData

public SequenceData getSequenceData()

Returns:

the sequenceData

getReceivedLevel

public double getReceivedLevel()

Returns:

the receivedLevel

getDistanceToAirgun

public Double getDistanceToAirgun()

Returns:

the distanceToAirgun

setDistanceToAirgun

public void setDistanceToAirgun(Double distanceToAirgun)

Parameters:

distanceToAirgun - the distanceToAirgun to set

getDistanceToHydrophone

public Double getDistanceToHydrophone()

Returns:

the distanceToHydrophone

setDistanceToHydrophone

public void setDistanceToHydrophone(Double distanceToHydrophone)

Parameters:

distanceToHydrophone - the distanceToHydrophone to set

toString

public String toString()

Overrides:

toString in class Object