Package adams.data.filter

Class TimeseriesRound

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<Timeseries>

adams.data.filter.TimeseriesRound

All Implemented Interfaces:

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

public class TimeseriesRound
extends AbstractFilter<Timeseries>

Rounds the values of the timeseries points.

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

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

-type <ROUND|CEILING|FLOOR|RINT> (property: type)
    The type of rounding to perform; ROUND: the closest integer to the argument,
     with ties rounding to positive infinity; CEILING: the smallest (closest
    to negative infinity) double value that is greater than or equal to the
    argument and is equal to a mathematical integer; FLOOR: the largest (closest
    to positive infinity) double value that is less than or equal to the argument
    and is equal to a mathematical integer; RINT: the double value that is closest
    in value to the argument and is equal to a mathematical integer
    default: ROUND
 

-num-decimals <int> (property: numDecimals)
    The number of decimals after the decimal point to use.
    default: 0
    minimum: 0
 

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 int	m_NumDecimals	the number of decimals.
protected RoundingType	m_Type	the rounding type.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
int	getNumDecimals()	Returns the number of decimals after the decimal point to use.
RoundingType	getType()	Returns the type of rounding to perform.
String	globalInfo()	Returns a string describing the object.
String	numDecimalsTipText()	Returns the tip text for this property.
protected Timeseries	processData(Timeseries data)	Performs the actual filtering.
void	setNumDecimals(int value)	Sets the number of decimals after the decimal point to use.
void	setType(RoundingType value)	Sets the type of rounding to perform.
String	typeTipText()	Returns the tip text for this property.

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_Type

protected RoundingType m_Type

the rounding type.

m_NumDecimals

protected int m_NumDecimals

the number of decimals.

Constructor Detail

TimeseriesRound

public TimeseriesRound()

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>

setType

public void setType(RoundingType value)

Sets the type of rounding to perform.

Parameters:

value - the type

getType

public RoundingType getType()

Returns the type of rounding to perform.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setNumDecimals

public void setNumDecimals(int value)

Sets the number of decimals after the decimal point to use.

Parameters:

value - the number of decimals

getNumDecimals

public int getNumDecimals()

Returns the number of decimals after the decimal point to use.

Returns:

the number of decimals

numDecimalsTipText

public String numDecimalsTipText()

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