Package adams.data.filter

Class AbstractFFT<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractFFT<T>

Type Parameters:

T - the type of data to process

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Filter>, SizeOfHandler, TechnicalInformationHandler, Filter<T>, Serializable, Comparable

Direct Known Subclasses:

TimeseriesFFT

public abstract class AbstractFFT<T extends DataContainer>
extends AbstractFilter<T>
implements TechnicalInformationHandler

Abstract ancestor for Fast Fourier Transform filters based on the JSci library.

Version:

$Revision: 9820 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_InverseTransform	whether to perform inverse transformation (wavelet -> normal space).
protected PaddingType	m_PaddingType	the type of padding to use.
protected boolean	m_Real	whether to return complex or real part of the transformation.

Fields inherited from class adams.data.filter.AbstractFilter

m_DontUpdateID

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
AbstractFFT()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getInverseTransform()	Returns whether to perform the inverse transform.
PaddingType	getPaddingType()	Returns the padding type.
boolean	getReal()	Returns whether to return the real or complex part of the result.
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
protected abstract double	getValue(DataPoint point)	Returns the Y-value of the DataPoint.
String	globalInfo()	Returns a string describing the object.
String	inverseTransformTipText()	Returns the tip text for this property.
protected abstract DataPoint	newDataPoint(List<DataPoint> points, int index, double y)	Creates a new DataPoint based on the index and the new Y value.
String	paddingTypeTipText()	Returns the tip text for this property.
protected T	processData(T data)	Performs the actual filtering.
String	realTipText()	Returns the tip text for this property.
void	setInverseTransform(boolean value)	Sets whether to perform the inverse transform.
void	setPaddingType(PaddingType value)	Sets the padding type.
void	setReal(boolean value)	Sets whether to return the real or complex part of the result.

Methods inherited from class adams.data.filter.AbstractFilter

checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_PaddingType

protected PaddingType m_PaddingType

the type of padding to use.

m_InverseTransform

protected boolean m_InverseTransform

whether to perform inverse transformation (wavelet -> normal space).

m_Real

protected boolean m_Real

whether to return complex or real part of the transformation.

Constructor Detail

AbstractFFT

public AbstractFFT()

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

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information about this class

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFilter<T extends DataContainer>

setPaddingType

public void setPaddingType(PaddingType value)

Sets the padding type.

Parameters:

value - the padding type

getPaddingType

public PaddingType getPaddingType()

Returns the padding type.

Returns:

the padding type

paddingTypeTipText

public String paddingTypeTipText()

Returns the tip text for this property.

Returns:

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

setInverseTransform

public void setInverseTransform(boolean value)

Sets whether to perform the inverse transform.

Parameters:

value - true if to perform the inverse transform

getInverseTransform

public boolean getInverseTransform()

Returns whether to perform the inverse transform.

Returns:

true if the inverse transform is performed

inverseTransformTipText

public String inverseTransformTipText()

Returns the tip text for this property.

Returns:

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

setReal

public void setReal(boolean value)

Sets whether to return the real or complex part of the result.

Parameters:

value - true if real part

getReal

public boolean getReal()

Returns whether to return the real or complex part of the result.

Returns:

true if real part

realTipText

public String realTipText()

Returns the tip text for this property.

Returns:

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

getValue

protected abstract double getValue(DataPoint point)

Returns the Y-value of the DataPoint.

Parameters:

point - the point to get the Y-Value from

Returns:

the Y-value

newDataPoint

protected abstract DataPoint newDataPoint(List<DataPoint> points,
                                          int index,
                                          double y)

Creates a new DataPoint based on the index and the new Y value. Used for padded points.

Parameters:

points - the original points

index - the index of the padded point in the output data

y - the new Y value

Returns:

the new DataPoint

processData

protected T processData(T data)

Performs the actual filtering.

Specified by:

processData in class AbstractFilter<T extends DataContainer>

Parameters:

data - the data to filter

Returns:

the filtered data