Package adams.data.autocorrelation

Class FFT

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.autocorrelation.AbstractAutoCorrelation

adams.data.autocorrelation.FFT

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, TechnicalInformationHandler, Serializable

public class FFT
extends AbstractAutoCorrelation
implements TechnicalInformationHandler

Uses FFT approach to autocorrelation.

For more information see:
WikiPedia. Autocorrelation.

 @misc{missing_id,
    author = {WikiPedia},
    title = {Autocorrelation},
    HTTP = {https://en.wikipedia.org/wiki/Autocorrelation}
 }
 

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-normalize <boolean> (property: normalize)
    Whether to normalize the data.
    default: false
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Normalize	whether to normalize.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
FFT()

Method Summary

Modifier and Type	Method	Description
protected void	check(double[] data)	Hook method for checks.
void	defineOptions()	Adds options to the internal list of options.
protected double[]	doCorrelate(double[] data)	Performs the actual autocorrelation on the data.
boolean	getNormalize()	Returns whether to normalize the data.
TechnicalInformation	getTechnicalInformation()	Returns technical information on autocorrelation.
String	globalInfo()	Returns a string describing the object.
String	normalizeTipText()	Returns the tip text for this property.
void	setNormalize(boolean value)	Sets whether to normalize the data.

Methods inherited from class adams.data.autocorrelation.AbstractAutoCorrelation

correlate

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Normalize

protected boolean m_Normalize

whether to normalize.

Constructor Detail

FFT

public FFT()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setNormalize

public void setNormalize(boolean value)

Sets whether to normalize the data.

Parameters:

value - true if to normalize

getNormalize

public boolean getNormalize()

Returns whether to normalize the data.

Returns:

true if to normalize

normalizeTipText

public String normalizeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns technical information on autocorrelation.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information

check

protected void check(double[] data)

Hook method for checks.

Overrides:

check in class AbstractAutoCorrelation

Parameters:

data - the data to check

doCorrelate

protected double[] doCorrelate(double[] data)

Performs the actual autocorrelation on the data.

Specified by:

doCorrelate in class AbstractAutoCorrelation

Parameters:

data - the data to process

Returns:

the processed data