Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class BearingChi2VarParams

java.lang.Object

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarParams

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.BearingChi2VarParams

All Implemented Interfaces:

Serializable, Cloneable, ManagedParameters

public class BearingChi2VarParams
extends SimpleChi2VarParams
implements ManagedParameters

Subclass of parameters for bearing. An extra bearing jump factor has been added. The reason for this is that if there are click trains

Author:

Jamie Macaulay

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BearingChi2VarParams.BearingJumpDrctn	Simple Enum indicating the direction the jump can be.

Field Summary

Fields

Modifier and Type	Field	Description
BearingChi2VarParams.BearingJumpDrctn	bearingJumpDrctn	Whether the bearing jump can be in both directions, positive or negative.
boolean	bearingJumpEnable	Whether the bearing jump is used.
double	maxBearingJump	The maximum allowed bearing bearing jump in a click train in RADIANS

Fields inherited from class clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarParams

errLimits, error, errorScaleValue, minError, name, SCALE_FACTOR_AMPLITUDE, SCALE_FACTOR_BEARING, SCALE_FACTOR_CORRELATION, SCALE_FACTOR_ICI, SCALE_FACTOR_PFREQ, SCALE_FACTOR_TIMEDELAYS

Constructor Summary

Constructors

Constructor	Description
BearingChi2VarParams(SimpleChi2VarParams params)
BearingChi2VarParams(String name)
BearingChi2VarParams(String name, String units)
BearingChi2VarParams(String name, String unitString, double error, double minError)
BearingChi2VarParams(String name, String unitString, double error, double minError, double errorScaleValue)

Method Summary

Modifier and Type	Method	Description
BearingChi2VarParams	clone()
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class

Methods inherited from class clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarParams

getUnits, getUnitString, toString

Methods inherited from class java.lang.Object

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

Field Details

bearingJumpEnable

public boolean bearingJumpEnable

Whether the bearing jump is used.

maxBearingJump

public double maxBearingJump

The maximum allowed bearing bearing jump in a click train in RADIANS

bearingJumpDrctn

public BearingChi2VarParams.BearingJumpDrctn bearingJumpDrctn

Whether the bearing jump can be in both directions, positive or negative. Note that this is useful for towed hydrophone arrays were we would almost always expect bearing changes to move from positive to negative. If a jump is for example, positive, then only large positive jumps will incure a penalty. Large negative jumps will be ignored (however will still create higher chi^2 values making them less diserable for the click train detector )

Constructor Details

BearingChi2VarParams

public BearingChi2VarParams(String name,
 String unitString,
 double error,
 double minError,
 double errorScaleValue)

BearingChi2VarParams

public BearingChi2VarParams(String name,
 String unitString,
 double error,
 double minError)

BearingChi2VarParams

public BearingChi2VarParams(String name)

BearingChi2VarParams

public BearingChi2VarParams(String name,
 String units)

BearingChi2VarParams

public BearingChi2VarParams(SimpleChi2VarParams params)

Method Details

clone

public BearingChi2VarParams clone()

Overrides:

clone in class SimpleChi2VarParams

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

Overrides:

getParameterSet in class SimpleChi2VarParams

Returns:

description of the parameters in a class.