Package adams.data.filter

Class DownSample<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.DownSample<T>

All Implemented Interfaces:

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

public class DownSample<T extends DataContainer>
extends AbstractFilter<T>

A filter that returns only every n-th data point.

-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
 

-nth <int> (property: nthPoint)
    Only every n-th point will be output.
    default: 1
 

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_NthPoint	the n-th point to use.

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

Method Summary

Modifier and Type	Method	Description
protected DataPoint	copy(int index, List<DataPoint> points)	Creates a copy of the data point.
void	defineOptions()	Adds options to the internal list of options.
int	getNthPoint()	Returns the nth point setting.
String	globalInfo()	Returns a string describing the object.
String	nthPointTipText()	Returns the tip text for this property.
protected T	processData(T data)	Performs the actual filtering.
void	setNthPoint(int value)	Sets the nth point setting.

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_NthPoint

protected int m_NthPoint

the n-th point to use.

Constructor Detail

DownSample

public DownSample()

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<T extends DataContainer>

setNthPoint

public void setNthPoint(int value)

Sets the nth point setting.

Parameters:

value - the nth point to use

getNthPoint

public int getNthPoint()

Returns the nth point setting.

Returns:

the nth point

nthPointTipText

public String nthPointTipText()

Returns the tip text for this property.

Returns:

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

copy

protected DataPoint copy(int index,
                         List<DataPoint> points)

Creates a copy of the data point.

Parameters:

index - the index in the data point list to copy

points - the list of data points

Returns:

the copy of the specified data point

processData

protected T processData(T data)

Performs the actual filtering.

Specified by:

processData in class AbstractFilter<T extends DataContainer>

Parameters:

data - the data to filter

Returns:

the filtered data