Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class CorrelationChi2Params

java.lang.Object

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarParams

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.CorrelationChi2Params

All Implemented Interfaces:

Serializable, Cloneable, ManagedParameters

public class CorrelationChi2Params
extends SimpleChi2VarParams
implements ManagedParameters

Parameters for correlation MHT variable

Author:

Jamie Macaulay

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
FFTFilterParams	fftFilterParams	The filter parameters.
boolean	useFilter	Use a filter for correlation calculations.

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
CorrelationChi2Params(SimpleChi2VarParams params)
CorrelationChi2Params(String name)	Parameters for the correlation chi^2
CorrelationChi2Params(String name, String unitString, double error, double minError, double errorScaleValue)

Method Summary

Modifier and Type	Method	Description
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

clone, getUnits, getUnitString, toString

Methods inherited from class java.lang.Object

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

Field Details

useFilter

public boolean useFilter

Use a filter for correlation calculations.

fftFilterParams

public FFTFilterParams fftFilterParams

The filter parameters. How the waveforms are filtered before corss correlation values are calculated.

Constructor Details

CorrelationChi2Params

public CorrelationChi2Params(String name)

Parameters for the correlation chi^2

Parameters:

name -

CorrelationChi2Params

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

CorrelationChi2Params

public CorrelationChi2Params(SimpleChi2VarParams params)

Method Details

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.