Package adams.data.filter

Class AbstractEquiDistanceWithOffset<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>

adams.data.filter.AbstractEquiDistanceWithOffset<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

public abstract class AbstractEquiDistanceWithOffset<T extends DataContainer>
extends AbstractEquiDistance<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 int	m_Offset	offset: add to timestamp/scan-num.

Fields inherited from class adams.data.filter.AbstractEquiDistance

m_AllowOversampling, m_NumPoints

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
int	getOffset()	Returns the offset for wave numbers (-1 if ignored).
abstract String	offsetTipText()	Returns the tip text for this property.
void	setOffset(int off)	Sets the offset for wave numbers (use -1 to ignore).

Methods inherited from class adams.data.filter.AbstractEquiDistance

allowOversamplingTipText, getAllowOversampling, getNumPoints, numPointsTipText, setAllowOversampling, setNumPoints

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_Offset

protected int m_Offset

offset: add to timestamp/scan-num.

Constructor Detail

AbstractEquiDistanceWithOffset

public AbstractEquiDistanceWithOffset()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractEquiDistance<T extends DataContainer>

setOffset

public void setOffset(int off)

Sets the offset for wave numbers (use -1 to ignore).

Parameters:

off - the offset

getOffset

public int getOffset()

Returns the offset for wave numbers (-1 if ignored).

Returns:

the offset

offsetTipText

public abstract String offsetTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui