Package adams.data.filter

Class TimeseriesFFT

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractFFT<Timeseries>

adams.data.filter.TimeseriesFFT

All Implemented Interfaces:

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

public class TimeseriesFFT
extends AbstractFFT<Timeseries>

A filter that transforms the data with Fast Fourier Transform.

For more information see:

Mark Hale (2009). JSci - A science API for Java.

 @misc{Hale2009,
    author = {Mark Hale},
    title = {JSci - A science API for Java},
    year = {2009},
    HTTP = {http://jsci.sourceforge.net/}
 }
 

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

-no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 

-padding <ZERO> (property: paddingType)
    The padding type to use.
    default: ZERO
 

-inverse <boolean> (property: inverseTransform)
    If true, then the inverse transform is performed.
    default: false
 

-real <boolean> (property: real)
    If enabled, the real part of the tranformation is returned.
    default: true
 

Version:

$Revision: 7305 $

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 inherited from class adams.data.filter.AbstractFFT

m_InverseTransform, m_PaddingType, m_Real

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

Method Summary

Modifier and Type	Method	Description
protected double	getValue(DataPoint point)	Returns the Y-value of the DataPoint.
protected DataPoint	newDataPoint(List<DataPoint> points, int index, double y)	Creates a new DataPoint based on the index and the new Y value.

Methods inherited from class adams.data.filter.AbstractFFT

defineOptions, getInverseTransform, getPaddingType, getReal, getTechnicalInformation, globalInfo, inverseTransformTipText, paddingTypeTipText, processData, realTipText, setInverseTransform, setPaddingType, setReal

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

Constructor Detail

TimeseriesFFT

public TimeseriesFFT()

Method Detail

getValue

protected double getValue(DataPoint point)

Returns the Y-value of the DataPoint.

Specified by:

getValue in class AbstractFFT<Timeseries>

Parameters:

point - the point to get the Y-Value from

Returns:

the Y-value

newDataPoint

protected 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.

Specified by:

newDataPoint in class AbstractFFT<Timeseries>

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