PamDetection
Class PamLocalisation

java.lang.Object
  PamguardMVC.PamDataUnit
      PamDetection.AcousticDataUnit
          PamDetection.PamDetection
              PamDetection.PamLocalisation

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

Deprecated.

@Deprecated
public class PamLocalisation
extends PamDetection

General class for handling localisation information for a PamDetection. Note that PamDetections may have lists of subDetections and superDetections (e.g. a click is a sub detection of a click train, a click train is a super detection of a click; a Whistle Peak is a sub detection of a Whistle Shape, etc.)

It's quite possible that the sub detections and the super detection will all have, or not have localisation information and the amount of information will vary depending on the detection.

This class therefore has a lot of has? type functions to see what types of information are available. Of course, these meed not always be called by many detectors, for instance, the simple IFAW 2 channel click detector knows that there will always be bearing information and no other information for every click. Generic plotting routines may find this stuff really useful though as might detectors / localisers that may be able to extract varying degrees of information from a detection.

Author:

Doug Gillespie

Field Summary

(package private) double[]	angle Deprecated.
(package private) double	depth Deprecated.
(package private) boolean	hasAngle Deprecated.
(package private) boolean	hasAngleAmbiguity Deprecated.
(package private) boolean	hasDepth Deprecated.
(package private) boolean	hasRange Deprecated.
(package private) double[]	heading Deprecated.
(package private) double[]	range Deprecated.
(package private) double[]	tilt Deprecated.

Fields inherited from class PamDetection.PamDetection

detectionType

Fields inherited from class PamDetection.AcousticDataUnit

AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD, duration, frequency, startSample

Fields inherited from class PamguardMVC.PamDataUnit

absBlockIndex, channelBitmap, localisation, oLL, timeMilliseconds

Constructor Summary

PamLocalisation(long timeMilliseconds, int istation, long startSample, long duration, boolean hasAngle, double angle, boolean hasAngleAmbiguity, boolean hasRange, double range, boolean hasDepth, double depth)
Deprecated.

Method Summary

double[]	getAngle() Deprecated.
double	getDepth() Deprecated.
double[]	getHeading() Deprecated.
double[]	getRange() Deprecated.
double[]	getTilt() Deprecated.
void	setAngle(double angle, int i) Deprecated.
void	setDepth(double depth) Deprecated.
void	setHeading(double heading, int i) Deprecated.
void	setRange(double range, int i) Deprecated.
void	setTilt(double tilt, int i) Deprecated.

Methods inherited from class PamDetection.PamDetection

addSubDetection, addSuperDetection, getDetectionType, getPeakTime, getSubDetection, getSubDetectionsCount, getSubDetectionSyncronisation, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, removeSubDetection, removeSuperDetection, setDetectionType, setPeakTime, setUniqueSuperDetection

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

clearUpdateCount, getAbsBlockIndex, getChannelBitmap, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getGpsPosition, getLastUpdateTime, getLocalisation, getOriginLatLong, getPairAngle, getParentDataBlock, getTimeMilliseconds, getUpdateCount, setAbsBlockIndex, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setLastUpdateTime, setLocalisation, setOriginLatLong, setParentDataBlock, setTimeMilliseconds, updateDataUnit

Methods inherited from class java.lang.Object

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

Field Detail

hasAngle

boolean hasAngle

Deprecated.

angle

double[] angle

Deprecated.

hasAngleAmbiguity

boolean hasAngleAmbiguity

Deprecated.

hasRange

boolean hasRange

Deprecated.

range

double[] range

Deprecated.

hasDepth

boolean hasDepth

Deprecated.

depth

double depth

Deprecated.

heading

double[] heading

Deprecated.

tilt

double[] tilt

Deprecated.

Constructor Detail

PamLocalisation

public PamLocalisation(long timeMilliseconds,
                       int istation,
                       long startSample,
                       long duration,
                       boolean hasAngle,
                       double angle,
                       boolean hasAngleAmbiguity,
                       boolean hasRange,
                       double range,
                       boolean hasDepth,
                       double depth)

Deprecated.

Parameters:

timeMilliseconds - Detection time in milliseconds (Java Callender)

istation -

startSample - Detectin start sample (from acquisition start)

duration - Detection duration in samples

hasAngle - Localisation has an angle

angle - Localisation angle

hasAngleAmbiguity - Localisation has angle ambiguity

hasRange - Localisation has range

range - Localisation range

hasDepth - Localisation has depth

depth - Localisation depth

Method Detail

getAngle

public double[] getAngle()

Deprecated.

setAngle

public void setAngle(double angle,
                     int i)

Deprecated.

getDepth

public double getDepth()

Deprecated.

setDepth

public void setDepth(double depth)

Deprecated.

getRange

public double[] getRange()

Deprecated.

setRange

public void setRange(double range,
                     int i)

Deprecated.

getHeading

public double[] getHeading()

Deprecated.

setHeading

public void setHeading(double heading,
                       int i)

Deprecated.

getTilt

public double[] getTilt()

Deprecated.

setTilt

public void setTilt(double tilt,
                    int i)

Deprecated.