Package adams.data.filter

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

All Implemented Interfaces:

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

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

A filter that picks a specified number of evenly spaced data points from the data. Does not introduce extra data points if there are too few points.

-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
 

-num-points <int> (property: numPoints)
    The number of points to pick from the input data.
    default: 100
    minimum: 1
 

Version:

$Revision: 1286 $

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_NumPoints	the number of points to retain.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int	getDefaultNumPoints()	Returns the default number of points to retain.
int	getNumPoints()	Returns the number of points to retain.
String	globalInfo()	Returns a string describing the object.
String	numPointsTipText()	Returns the tip text for this property.
protected T	processData(T data)	Performs the actual filtering.
void	setNumPoints(int value)	Sets the number of points to retain.

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_NumPoints

protected int m_NumPoints

the number of points to retain.

Constructor Detail

DownSize

public DownSize()

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>

getDefaultNumPoints

protected int getDefaultNumPoints()

Returns the default number of points to retain.

Returns:

the default

setNumPoints

public void setNumPoints(int value)

Sets the number of points to retain.

Parameters:

value - the number

getNumPoints

public int getNumPoints()

Returns the number of points to retain.

Returns:

the number

numPointsTipText

public String numPointsTipText()

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