Package group3dlocaliser.algorithm.toadbase

Class TOADBaseParams

java.lang.Object

group3dlocaliser.algorithm.toadbase.TOADBaseParams

All Implemented Interfaces:

Serializable, Cloneable, ManagedParameters

public class TOADBaseParams
extends Object
implements Cloneable, Serializable, ManagedParameters

Parameters that apply to all TOAD based localisers. Note that parameters controlling TOAD calculations are held within the individual TOAD calculators since they may have data type specific options, so can't be handled by this more generic part of the localisation system.

Author:

dg50

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
TOADBaseParams()

Method Summary

Modifier and Type	Method	Description
protected TOADBaseParams	clone()
int	getChannelBitmap()
int	getMinCorrelatedGroups()	Minimum number of channel groups that have at least one acceptable
double	getMinCorrelation()	Minimum cross correlation value within a channel pair for it to be used in localisation
int	getMinTimeDelays()	Minimum number of time delays that have an acceptable correlation value
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class
void	setChannelBitmap(int channelBitmap)
void	setMinCorrelatedGroups(int minCorrelatedGroups)	Minimum number of channel groups that have at least one acceptable
void	setMinCorrelation(double minCorrelation)	Minimum cross correlation value within a channel pair for it to be used in localisation
void	setMinTimeDelays(int minTimeDelays)	Minimum number of time delays that have an acceptable correlation value

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

public static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

TOADBaseParams

public TOADBaseParams()

Method Details

getChannelBitmap

public int getChannelBitmap()

Returns:

the channelBitmap

setChannelBitmap

public void setChannelBitmap(int channelBitmap)

Parameters:

channelBitmap - the channelBitmap to set

clone

protected TOADBaseParams clone()

Overrides:

clone in class Object

getMinCorrelation

public double getMinCorrelation()

Minimum cross correlation value within a channel pair for it to be used in localisation

Returns:

the minCorrelation

setMinCorrelation

public void setMinCorrelation(double minCorrelation)

Minimum cross correlation value within a channel pair for it to be used in localisation

Parameters:

minCorrelation - the minCorrelation to set

getMinCorrelatedGroups

public int getMinCorrelatedGroups()

Minimum number of channel groups that have at least one acceptable

Returns:

the minCorrelatedGroups

setMinCorrelatedGroups

public void setMinCorrelatedGroups(int minCorrelatedGroups)

Minimum number of channel groups that have at least one acceptable

Parameters:

minCorrelatedGroups - the minCorrelatedGroups to set

getMinTimeDelays

public int getMinTimeDelays()

Minimum number of time delays that have an acceptable correlation value

Returns:

the minTimeDelays

setMinTimeDelays

public void setMinTimeDelays(int minTimeDelays)

Minimum number of time delays that have an acceptable correlation value

Parameters:

minTimeDelays - the minTimeDelays to set

getParameterSet

public PamParameterSet getParameterSet()

Description copied from interface: ManagedParameters

Get a set of data that describes all of the parameters in a class

Specified by:

getParameterSet in interface ManagedParameters

Returns:

description of the parameters in a class.