Package adams.flow.transformer.timeseriessplit

Class FixedLengthSegments

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

adams.flow.transformer.timeseriessplit.FixedLengthSegments

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class FixedLengthSegments
extends AbstractTimeseriesSplitter

Splits the timeseries into segements of a fixed length, i.e., number of data points.

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

-num-points <int> (property: numPoints)
    The number of data points for a segment.
    default: 100
    minimum: 1
    maximum: 0
 

-discard-partial <boolean> (property: discardPartial)
    If enabled, partial segments get discarded, ie the last one if not sufficient 
    data points.
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_DiscardPartial	whether to discard partial segments (ie the last one).
protected int	m_NumPoints	the number of data points.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	discardPartialTipText()	Returns the tip text for this property.
protected Timeseries[]	doSplit(Timeseries series)	Performs the actual split.
boolean	getDiscardPartial()	Returns whether to discard partial segments.
int	getNumPoints()	Returns the number of points for a segment.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	numPointsTipText()	Returns the tip text for this property.
void	setDiscardPartial(boolean value)	Sets whether to discard partial segments.
void	setNumPoints(int value)	Sets the number of points for a segment.

Methods inherited from class adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

check, postProcess, split

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_NumPoints

protected int m_NumPoints

the number of data points.

m_DiscardPartial

protected boolean m_DiscardPartial

whether to discard partial segments (ie the last one).

Constructor Detail

FixedLengthSegments

public FixedLengthSegments()

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 AbstractOptionHandler

setNumPoints

public void setNumPoints(int value)

Sets the number of points for a segment.

Parameters:

value - the number of points

getNumPoints

public int getNumPoints()

Returns the number of points for a segment.

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 or for listing the options.

setDiscardPartial

public void setDiscardPartial(boolean value)

Sets whether to discard partial segments.

Parameters:

value - ture if to discard

getDiscardPartial

public boolean getDiscardPartial()

Returns whether to discard partial segments.

Returns:

true if to discard

discardPartialTipText

public String discardPartialTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractTimeseriesSplitter

Returns:

null if no info available, otherwise short string

doSplit

protected Timeseries[] doSplit(Timeseries series)

Performs the actual split.

Specified by:

doSplit in class AbstractTimeseriesSplitter

Parameters:

series - the timeseries to split

Returns:

the generated sub-timeseries