difar.trackedGroups

Class TrackedGroupDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

PamDetection.AcousticDataUnit

difar.trackedGroups.TrackedGroupDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

public class TrackedGroupDataUnit
extends AcousticDataUnit

Author:

Brian Miller Each data unit represents a group of whales tracked via the DIFAR module. The data unit will contain summary information regarding the track, such as first detection time, total number of detections average bearing, most recent bearing.

Field Summary

Fields inherited from class PamDetection.AcousticDataUnit

AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Constructor Summary

Constructors

Constructor and Description
TrackedGroupDataUnit(DifarDataUnit difarDataUnit) Create a new trackedGroup data unit from an existing difarDataUnit
TrackedGroupDataUnit(long timeMilliseconds, int channelBitmap, java.lang.String groupName, double firstBearing, double lastBearing, long lastDetectionTime, double meanBearing, double bearingSTD, int n) Create a new TrackedGroupDataUnit from the SQL database

Method Summary

Methods

Modifier and Type	Method and Description
void	addData(DifarDataUnit difarDataUnit) Add a new bearing to this group.
double	getBearingSTD()
java.lang.String	getBuoyName()
long	getBuoyStartTime()
long	getFirstDetectionTime()
java.lang.String	getGroupName()
double	getMeanBearing() The circular mean of all of the bearings for this group
double	getMostRecentBearing()
long	getMostRecentDetectionTime() The time of the most recent bearing to this group
int	getNumBearings()
java.lang.String	getSummaryString() Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
void	setFirstDetectionTime(long timeMillis)
void	updateMostRecentBearing(DifarDataUnit difarDataUnit)

Methods inherited from class PamDetection.AcousticDataUnit

amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, compareTo, getAmplitudeDB, getCalculatedAmlitudeDB, getDuration, getFrequency, getFrequencyOverlap, getLastSample, getMeasuredAmplitude, getMeasuredAmplitudeType, getSeconds, getStartSample, getTimeOverlap, setCalculatedAmlitudeDB, setDuration, setFrequency, setInfo, setMeasuredAmplitude, setMeasuredAmplitude, setMeasuredAmplitudeType, setStartSample

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, clearOandAngles, clearUpdateCount, findDataAnnotation, getAbsBlockIndex, getChannelBitmap, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDetectionMatch, getDetectionMatch, getHydrophoneHeading, getLastUpdateTime, getLocalisation, getNumDataAnnotations, getOriginLatLong, getPairAngle, getParentDataBlock, getTimeMilliseconds, getUpdateCount, removeDataAnnotation, removeDataAnnotation, setAbsBlockIndex, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setLastUpdateTime, setLocalisation, setOriginLatLong, setParentDataBlock, setTimeMilliseconds, updateDataUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackedGroupDataUnit

public TrackedGroupDataUnit(DifarDataUnit difarDataUnit)

Create a new trackedGroup data unit from an existing difarDataUnit

Parameters:

difarDataUnit -

TrackedGroupDataUnit

public TrackedGroupDataUnit(long timeMilliseconds,
                    int channelBitmap,
                    java.lang.String groupName,
                    double firstBearing,
                    double lastBearing,
                    long lastDetectionTime,
                    double meanBearing,
                    double bearingSTD,
                    int n)

Create a new TrackedGroupDataUnit from the SQL database

Parameters:

bearingSTD -

difarDataUnit -

Method Detail

addData

public void addData(DifarDataUnit difarDataUnit)

Add a new bearing to this group. Check if its the most recent and update accordingly. Also, recompute the mean bearing.

Parameters:

difarDataUnit -

updateMostRecentBearing

public void updateMostRecentBearing(DifarDataUnit difarDataUnit)

getSummaryString

public java.lang.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 AcousticDataUnit

Returns:

summary string

getGroupName

public java.lang.String getGroupName()

getBuoyName

public java.lang.String getBuoyName()

getFirstDetectionTime

public long getFirstDetectionTime()

setFirstDetectionTime

public void setFirstDetectionTime(long timeMillis)

getMostRecentDetectionTime

public long getMostRecentDetectionTime()

The time of the most recent bearing to this group

Returns:

getMostRecentBearing

public double getMostRecentBearing()

getMeanBearing

public double getMeanBearing()

The circular mean of all of the bearings for this group

Returns:

getBearingSTD

public double getBearingSTD()

getBuoyStartTime

public long getBuoyStartTime()

getNumBearings

public int getNumBearings()

Returns:

The total number of bearings for this group on this sonobuoy