PamDetection

Class AbstractDetectionMatch

java.lang.Object

PamDetection.AbstractDetectionMatch

All Implemented Interfaces:

DetectionMatchModel

Direct Known Subclasses:

ClickDetectionMatch

public abstract class AbstractDetectionMatch
extends java.lang.Object
implements DetectionMatchModel

This class aims to match detections picked up on different hydrophones, primarily on WIDE APERTURE arrays. Although this technique should also work on closely spaced elements AbstractLocalisation should be used instead. Note that matching detections on different hydrophones is the initial step taken in localisation using wide aperture arrays. Often there are multiple possibilities for the correct detection on each hydrophone. These can be somewhat reduced, for example by using classifiers, although it may be necessary to pass multiple possible combinations of clicks (i.e multiple sets of time delays) to the localisation algorithm.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor and Description
AbstractDetectionMatch(PamDataUnit pamDataUnit)
AbstractDetectionMatch(PamDataUnit pamDataUnit, java.lang.Integer detectionType)

Method Summary

Methods

Modifier and Type	Method and Description
static int	calcHydrophoneNumber(int numberOfDelays) For N synchronised hydrophones there are N*(N-1)/2 time delays.
static int	calcTDNumber(int numberofHydrophones) For N synchronised hydrophones there are N*(N-1)/2 time delays.
static boolean	containsChannel(int[] channels, int channel) Simple functions which return true if the array channels contains the int channel.
PamDataUnit	findClosestDetection(int[] channelMap) Gets the detection closest detection to the primary detection within the channel map and within time windows.
java.util.ArrayList<PamDataUnit>	findDetectionGroup() We want to be into and out of the PamDataBlock as quickly and as few times as possible.
PamDataUnit	getDetection()
java.util.ArrayList<PamDataUnit>	getDetectionGroup()
static java.util.ArrayList<PamDetection>	getDetectionMap(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelayPossibility) Every time delay possibility corresponds to a set of detections, up to one for each channel.
java.lang.Integer	getDetectionType()
double[]	getHydrophoneDistances(long timeMillis) Get the current array and calculate the distances between every hydrophone element;
java.util.ArrayList<PamVector>	getHydrophones(long timeMillis)
java.util.ArrayList<javax.vecmath.Point3f>	getHydrophones3f(long timeMillis)
int	getNumberofHydrophones() Get the number of hydrophones in the hydrophone array,
DetectionMatchWorker	getObserverThread() Get the observer thread.
PamDataBlock	getParentDetections()
int	getPrimaryChannel() Get the primary hydrophone channel.
TDArrayList<java.lang.Double>	getTDErrrorsAll() Calculate all the time delay errors for this pamDetection.
static double	getTimeDelayError(int H0, int H1, long timeMillis, PamArray currentArray) Returns the location time delay error between hydrophones H0 and H1 based on location error specified by the user in the hydrophone array manager.
double	getTimeWindowAddition() Get the time window addition.
double[]	getTimeWindows(long timeMillis) Time windows are needed to match clicks.
double[]	getTimeWindows(long timeMillis, int[] channels) Time windows are needed to match clicks.
static java.util.ArrayList<java.lang.Integer>	indexM1(int numberOfHydrophones) IndexM1 and IndexM2 specify which hydrophones to calculate time delays between.
static java.util.ArrayList<java.lang.Integer>	indexM2(int numberOfHydrophones) IndexM1 and IndexM2 specify which hydrophones to calculate time delays between.
static <T> int[][]	mapPossibleCombinations(java.util.ArrayList<java.util.ArrayList<T>> dataAll) Make a map of all possible detections or time delays.
void	setDetection(PamDetection parentDetection)
void	setDetectionType(java.lang.Integer detectionType)
void	setObserverThread(DetectionMatchWorker observerThread) Set the observer thread for time delay calculation.
void	setParentDetections(PamDataBlock parentBlock) Set Pamdatablock
void	setTimeWindowAddition(double timeWindowAddition)
static boolean	testTimeDelays(java.util.ArrayList<java.util.ArrayList<java.lang.Double>> timeDelays) Simple function to test time delays are not all null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamDetection.DetectionMatchModel

canLocalise, getGroupTimeDelays, getNMatchDetections, getNPossibilities

Constructor Detail

AbstractDetectionMatch

public AbstractDetectionMatch(PamDataUnit pamDataUnit)

AbstractDetectionMatch

public AbstractDetectionMatch(PamDataUnit pamDataUnit,
                      java.lang.Integer detectionType)

Method Detail

findDetectionGroup

public java.util.ArrayList<PamDataUnit> findDetectionGroup()

We want to be into and out of the PamDataBlock as quickly and as few times as possible. So find the max time window, grab all detections on all channels within this time window and then we can sort them out once allocated to a different section of memory.

Specified by:

findDetectionGroup in interface DetectionMatchModel

Returns:

all detections within the maximum time window of pamDataUnit.

getDetectionGroup

public java.util.ArrayList<PamDataUnit> getDetectionGroup()

findClosestDetection

public PamDataUnit findClosestDetection(int[] channelMap)

Gets the detection closest detection to the primary detection within the channel map and within time windows. Used to look at synchronised data.

getNumberofHydrophones

public int getNumberofHydrophones()

Get the number of hydrophones in the hydrophone array,

Returns:

the number of hydrophones in the current array.

getHydrophoneDistances

public double[] getHydrophoneDistances(long timeMillis)

Get the current array and calculate the distances between every hydrophone element;

Returns:

containsChannel

public static boolean containsChannel(int[] channels,
                      int channel)

Simple functions which return true if the array channels contains the int channel.

Parameters:

channels -

Returns:

getHydrophones

public java.util.ArrayList<PamVector> getHydrophones(long timeMillis)

Returns:

a list of PamVectors denoting hydrophone positions;

getHydrophones3f

public java.util.ArrayList<javax.vecmath.Point3f> getHydrophones3f(long timeMillis)

Returns:

a list of Point3f's denoting hydrophone positions;

getTimeWindows

public double[] getTimeWindows(long timeMillis)

Time windows are needed to match clicks. These correspond to the inter element distances with an array, Note that the time window for the primary hydrophone is 0; Hydrophones are ordered as in the array manager

Returns:

a double of the time window in SECONDS from the primary hydrophone to each other hydrophone within the array. Time windows are arranged by channels, i.e. timeWindows[0] is the time window between channel 0 and the primary hydrophone...etc

getTimeWindows

public double[] getTimeWindows(long timeMillis,
                      int[] channels)

Time windows are needed to match clicks. These correspond to the inter element distances with an array, Note that the time window for the primary hydrophone is 0; Hydrophones are ordered as in the array manager

Returns:

a double of the time window in SECONDS from the primary hydrophone to each other hydrophone within the array. Time windows are arranged by channels, i.e. timeWindows[0] is the time window between channel 0 and the primary hydrophone...etc

getPrimaryChannel

public int getPrimaryChannel()

Get the primary hydrophone channel.

Returns:

the reference channel used to create the groups.

getDetection

public PamDataUnit getDetection()

Returns:

Parent detection containing this localisation information

setDetection

public void setDetection(PamDetection parentDetection)

Parameters:

parentDetection - Parent detection containing this detection match information

getParentDetections

public PamDataBlock getParentDetections()

Returns:

Parent detection

setParentDetections

public void setParentDetections(PamDataBlock parentBlock)

Set Pamdatablock

Parameters:

parentBlock -

indexM2

public static java.util.ArrayList<java.lang.Integer> indexM2(int numberOfHydrophones)

IndexM1 and IndexM2 specify which hydrophones to calculate time delays between. In the case of a paired array this will simply be the hydrophones in pairs so Index M1 will be 0 and even numbers and IndexM2 will be odd numbers.

Returns:

indexM1

public static java.util.ArrayList<java.lang.Integer> indexM1(int numberOfHydrophones)

IndexM1 and IndexM2 specify which hydrophones to calculate time delays between. In the case of a paired array this will simply be the hydrophones in pairs so Index M1 will be 0 and even numbers and IndexM2 will be odd numbers.

Returns:

calcHydrophoneNumber

public static int calcHydrophoneNumber(int numberOfDelays)

For N synchronised hydrophones there are N*(N-1)/2 time delays. For N time delays there are 0.5+sqrt(1+2N)/2 hydrophones. This function calculates the number of hydrophones from the number of time delays.

Returns:

the number of hydrophones required to have numberOfDelays time delays

calcTDNumber

public static int calcTDNumber(int numberofHydrophones)

For N synchronised hydrophones there are N*(N-1)/2 time delays. For N time delays there are 0.5+sqrt(1+2N)/2 hydrophone. This is a simple function which calculates the number of time delays from the number of hydrophones.

Returns:

the number of time delays which would result if every hydrophone (numberofHydrophones) received a detection.

getTimeDelayError

public static double getTimeDelayError(int H0,
                       int H1,
                       long timeMillis,
                       PamArray currentArray)

Returns the location time delay error between hydrophones H0 and H1 based on location error specified by the user in the hydrophone array manager. Note errors must be calculated carufully- there are two kinds of hydrophone error, the errors between the hydrophones themselves and then the error within the streamer.

Parameters:

channel - number H0

channel - number H1

speed - of sound c

Returns:

The time delay error between H1 and H2, based on location errors.

getTDErrrorsAll

public TDArrayList<java.lang.Double> getTDErrrorsAll()

Calculate all the time delay errors for this pamDetection.

Returns:

an ArrayList of time delay errors based on IndexM1/M2

setDetectionType

public void setDetectionType(java.lang.Integer detectionType)

getDetectionType

public java.lang.Integer getDetectionType()

getTimeWindowAddition

public double getTimeWindowAddition()

Get the time window addition. This adds a certain amount of extra time to the time window.

Returns:

the extra time added to the timewindows fior the detection match.

setTimeWindowAddition

public void setTimeWindowAddition(double timeWindowAddition)

mapPossibleCombinations

public static <T> int[][] mapPossibleCombinations(java.util.ArrayList<java.util.ArrayList<T>> dataAll)

Make a map of all possible detections or time delays.

Parameters:

List - of to calculate all possible combination of elements for;

Returns:

int[][] with combination indices.

getDetectionMap

public static java.util.ArrayList<PamDetection> getDetectionMap(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelayPossibility)

Every time delay possibility corresponds to a set of detections, up to one for each channel.

Parameters:

timeDelayPossibility- - set of time delays.

Returns:

a list of detections corresponding to the dataunits used to calculate time delays

testTimeDelays

public static boolean testTimeDelays(java.util.ArrayList<java.util.ArrayList<java.lang.Double>> timeDelays)

Simple function to test time delays are not all null. Try to use as little as possible.

Parameters:

timeDelays -

Returns:

true if at least one delay is present. False if no delays or all delays null.

getObserverThread

public DetectionMatchWorker getObserverThread()

Get the observer thread. This is a thread used to calculate time delays if calculation is going to take a while.

Returns:

observer thread

setObserverThread

public void setObserverThread(DetectionMatchWorker observerThread)

Set the observer thread for time delay calculation. Move the time delay calculation to a new thread.

Parameters:

observerThread -