Package adams.data.filter

Class AbstractEquiDistance<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractEquiDistance<T>

Type Parameters:

T - the type of data to filter

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEquiDistanceWithOffset, TimeseriesEquiDistance

public abstract class AbstractEquiDistance<T extends DataContainer>
extends AbstractFilter<T>

Abstract ancestor for filters that equi-distance the 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

Modifier and Type	Field	Description
protected boolean	m_AllowOversampling	indicates whether oversampling is allowed, i.e., generating more points than were available in the original data.
protected int	m_NumPoints	the number of points to output ("-1" uses the same amount of points as currently in the data).

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

Method Summary

Modifier and Type	Method	Description
String	allowOversamplingTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
boolean	getAllowOversampling()	Returns whether oversampling is allowed (i.e., generate more data points than available in the original data).
int	getNumPoints()	Returns the number of points to output.
String	numPointsTipText()	Returns the tip text for this property.
void	setAllowOversampling(boolean value)	Sets whether oversampling is allowed (i.e., generate more data points than available in the original data).
void	setNumPoints(int value)	Sets the number of points to use.

Methods inherited from class adams.data.filter.AbstractFilter

checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, processData, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_NumPoints

protected int m_NumPoints

the number of points to output ("-1" uses the same amount of points as currently in the data).

m_AllowOversampling

protected boolean m_AllowOversampling

indicates whether oversampling is allowed, i.e., generating more points than were available in the original data.

Constructor Detail

AbstractEquiDistance

public AbstractEquiDistance()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFilter<T extends DataContainer>

setNumPoints

public void setNumPoints(int value)

Sets the number of points to use.

Parameters:

value - the number of points

getNumPoints

public int getNumPoints()

Returns the number of points to output.

Returns:

the number of points

numPointsTipText

public String numPointsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setAllowOversampling

public void setAllowOversampling(boolean value)

Sets whether oversampling is allowed (i.e., generate more data points than available in the original data).

Parameters:

value - if true oversampling is allowed

getAllowOversampling

public boolean getAllowOversampling()

Returns whether oversampling is allowed (i.e., generate more data points than available in the original data).

Returns:

true if oversampling is allowed

allowOversamplingTipText

public String allowOversamplingTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui