Package adams.data.filter

Class TimeseriesEquiDistance

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractEquiDistance<Timeseries>

adams.data.filter.TimeseriesEquiDistance

All Implemented Interfaces:

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

public class TimeseriesEquiDistance
extends AbstractEquiDistance<Timeseries>

A filter for interpolating the values of a time series. One can either specify a fixed number of points or just use the same amount of points as currently in the input data.

Valid options are:

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

-num-points <int> (property: numPoints)
    The number of points to generate, '-1' will use the same amount of points 
    as currently in the input data.
    default: -1
    minimum: -1
 

-allow-oversampling (property: allowOversampling)
    If set to true, then over-sampling is allowed, ie, generating more data 
    points than in the original data.
 

Version:

$Revision$

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

m_AllowOversampling, m_NumPoints

Fields inherited from class adams.data.filter.AbstractFilter

m_DontUpdateID, m_DontUpdateProcessingInfo

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

Method Summary

Modifier and Type	Method	Description
String	globalInfo()	Returns a string describing the object.
protected TimeseriesPoint	interpolate(long time, TimeseriesPoint left, TimeseriesPoint right)	Returns a TimeseriesPoint with interpolated value.
protected Timeseries	processData(Timeseries data)	Performs the actual filtering.

Methods inherited from class adams.data.filter.AbstractEquiDistance

allowOversamplingTipText, defineOptions, getAllowOversampling, getNumPoints, numPointsTipText, setAllowOversampling, setNumPoints

Methods inherited from class adams.data.filter.AbstractFilter

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

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

TimeseriesEquiDistance

public TimeseriesEquiDistance()

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

interpolate

protected TimeseriesPoint interpolate(long time,
                                      TimeseriesPoint left,
                                      TimeseriesPoint right)

Returns a TimeseriesPoint with interpolated value.

Parameters:

time - the time (msecs) we have to interpolate for

left - the "earlier" TimeseriesPoint

right - the "later" TimeseriesPoint

Returns:

the interpolated TimeseriesPoint

processData

protected Timeseries processData(Timeseries data)

Performs the actual filtering.

Specified by:

processData in class AbstractFilter<Timeseries>

Parameters:

data - the data to filter

Returns:

the filtered data