Package Localiser.algorithms

Class TimeDelayData

java.lang.Object

Localiser.algorithms.TimeDelayData

public class TimeDelayData
extends Object

Class to pass round time delay data. Can contain correlation scores and error estimates as well as the actual delays.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
TimeDelayData(double delay)
TimeDelayData(double delay, double delayScore)
TimeDelayData(double delay, double delayError, double delayScore)

Method Summary

Modifier and Type	Method	Description
double	addDelayOffset(double delayOffset)	Add a constant offset to the time delay
static double[]	extractDelays(TimeDelayData[] timeDelayDatas)	Extract just the delay data from a set of timeDelayDatas. In an ideal world no one would use this since it's better to also retain the correlation height and error data, but this method does allow for easy reprogramming of existing localisers
double	getDelay()
double	getDelayError()
double	getDelayScore()
double	scaleDelay(double scaleFactor)	Multiply the delay by a constant
void	setDelay(double delay)
void	setDelayError(double delayError)
void	setDelayScore(double delayScore)

Methods inherited from class java.lang.Object

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

Constructor Details

TimeDelayData

public TimeDelayData(double delay,
 double delayError,
 double delayScore)

Parameters:

delayError - Time delay error in seconds

delayScore - Delay score (correlation value, scale 0 - 1)

delaySeconds - Time delay in seconds

TimeDelayData

public TimeDelayData(double delay,
 double delayScore)

Parameters:

delayScore - Delay score (correlation value, scale 0 - 1)

delaySeconds - Time delay in seconds

TimeDelayData

public TimeDelayData(double delay)

Parameters:

delaySeconds - Time delay in seconds

delayScore - Delay score (correlation value, scale 0 - 1)

Method Details

getDelayError

public double getDelayError()

Returns:

the delayError

setDelayError

public void setDelayError(double delayError)

Parameters:

delayError - set the delayError

getDelayScore

public double getDelayScore()

Returns:

the delayScore

setDelayScore

public void setDelayScore(double delayScore)

Parameters:

delayScore - the delayScore to set

getDelay

public double getDelay()

Returns:

the delay in seconds

setDelay

public void setDelay(double delay)

Parameters:

delay - the delay to set in seconds

scaleDelay

public double scaleDelay(double scaleFactor)

Multiply the delay by a constant

Parameters:

scaleFactor -

Returns:

updated delay value

addDelayOffset

public double addDelayOffset(double delayOffset)

Add a constant offset to the time delay

Parameters:

delayOffset - in same units as the time delay.

Returns:

updated delay value

extractDelays

public static double[] extractDelays(TimeDelayData[] timeDelayDatas)

Extract just the delay data from a set of timeDelayDatas.
In an ideal world no one would use this since it's better to also retain the correlation height and error data, but this method does allow for easy reprogramming of existing localisers

Parameters:

timeDelayDatas - array of timeDelayDatas

Returns:

array of time delays.