Package adams.data.filter

Class TimeseriesShiftValues

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<Timeseries>

adams.data.filter.TimeseriesShiftValues

All Implemented Interfaces:

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

public class TimeseriesShiftValues
extends AbstractFilter<Timeseries>

Shifts the values of the timeseries by the specified amount (up or down, depending on the sign).

-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
 

-amount <double> (property: amount)
    The amount to shift the values by.
    default: 0.0
 

Version:

$Revision: 7789 $

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 double	m_Amount	the amount to shift the values by.

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

Method Summary

Modifier and Type	Method	Description
String	amountTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
double	getAmount()	Returns the amount to shift the values by.
String	globalInfo()	Returns a string describing the object.
protected Timeseries	processData(Timeseries data)	Performs the actual filtering.
void	setAmount(double value)	Sets the amount to shift the values by.

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_Amount

protected double m_Amount

the amount to shift the values by.

Constructor Detail

TimeseriesShiftValues

public TimeseriesShiftValues()

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 AbstractFilter<Timeseries>

setAmount

public void setAmount(double value)

Sets the amount to shift the values by.

Parameters:

value - the amount

getAmount

public double getAmount()

Returns the amount to shift the values by.

Returns:

the amount

amountTipText

public String amountTipText()

Returns the tip text for this property.

Returns:

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

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