Package adams.data.filter

Class TimeseriesDerivative

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractDerivative<Timeseries>

adams.data.filter.TimeseriesDerivative

All Implemented Interfaces:

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

public class TimeseriesDerivative
extends AbstractDerivative<Timeseries>

A filter for generating derivatives of timeseries 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
 

-order <int> (property: order)
    The order of the derivative to calculate.
    default: 1
 

-scaling <double> (property: scalingRange)
    The range to scale the abundances to after each derivation step; use 0 to 
    turn off and -1 to set it to the input range.
    default: 0.0
 

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

AbstractDerivative.Point

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

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

Fields inherited from class adams.data.filter.AbstractDerivative

m_Order, m_ScalingRange

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

Method Summary

Modifier and Type	Method	Description
String	globalInfo()	Returns a string describing the object.
protected DataPoint	toDataPoint(AbstractDerivative.Point point)	Turns the intermediate format point back into a DataPoint.
protected AbstractDerivative.Point	toPoint(DataPoint point)	Turns the DataPoint into the intermediate format.

Methods inherited from class adams.data.filter.AbstractDerivative

defineOptions, derive, getOrder, getScalingRange, orderTipText, processData, scalingRangeTipText, setOrder, setScalingRange

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

TimeseriesDerivative

public TimeseriesDerivative()

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

toPoint

protected AbstractDerivative.Point toPoint(DataPoint point)

Turns the DataPoint into the intermediate format.

Specified by:

toPoint in class AbstractDerivative<Timeseries>

Parameters:

point - the DataPoint to convert

Returns:

the generated intermediate format point

toDataPoint

protected DataPoint toDataPoint(AbstractDerivative.Point point)

Turns the intermediate format point back into a DataPoint.

Specified by:

toDataPoint in class AbstractDerivative<Timeseries>

Parameters:

point - the intermediate format point to convert

Returns:

the generated DataPoint