Package adams.flow.transformer

Class TimeseriesFeatureGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.TimeseriesFeatureGenerator

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, VariableMonitor, FeatureGenerator<AbstractTimeseriesFeatureGenerator>, Serializable, Comparable

public class TimeseriesFeatureGenerator
extends AbstractTransformer
implements FeatureGenerator<AbstractTimeseriesFeatureGenerator>

Applies a timeseries feature generator to the incoming timeseries and outputs the generated features.

Input/output:
- accepts:
adams.data.timeseries.Timeseries
- generates:
adams.data.spreadsheet.Row

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

-name <java.lang.String> (property: name)
    The name of the actor.
    default: TimeseriesFeatureGenerator
 

-annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 

-algorithm <adams.data.timeseries.AbstractTimeseriesFeatureGenerator> (property: algorithm)
    The feature generation algorithm to use.
    default: adams.data.timeseries.Values -converter \"adams.data.featureconverter.SpreadSheetFeatureConverter -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet\"
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_ALGORITHM	the key for storing the current algorithm in the backup.
static String	BACKUP_QUEUE	the key for storing the current objects in the backup.
protected AbstractTimeseriesFeatureGenerator	m_ActualAlgorithm	the actual algorithm to apply to the image.
protected AbstractTimeseriesFeatureGenerator	m_Algorithm	the feature generator to use.
protected ArrayList	m_Queue	the generated objects.
protected VariableName	m_VariableName	the variable to listen to.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
TimeseriesFeatureGenerator()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	algorithmTipText()	Returns the tip text for this property.
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
Class[]	generates()	Returns the class of objects that it generates.
AbstractTimeseriesFeatureGenerator	getAlgorithm()	Returns the algorithm in use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
VariableName	getVariableName()	Returns the name of the variable to monitor.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
protected void	initialize()	Initializes the members.
Token	output()	Returns the generated token.
protected void	pruneBackup()	Removes entries from the backup.
protected void	reset()	Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
void	setAlgorithm(AbstractTimeseriesFeatureGenerator value)	Sets the algorithm to use.
void	setVariableName(VariableName value)	Sets the name of the variable to monitor.
void	variableChanged(VariableChangeEvent e)	Gets triggered when a variable changed (added, modified, removed).
String	variableNameTipText()	Returns the tip text for this property.
void	wrapUp()	Cleans up after the execution has finished.

Methods inherited from class adams.flow.transformer.AbstractTransformer

currentInput, execute, hasInput, input, postExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

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

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

BACKUP_QUEUE

public static final String BACKUP_QUEUE

the key for storing the current objects in the backup.

See Also:

Constant Field Values

BACKUP_ALGORITHM

public static final String BACKUP_ALGORITHM

the key for storing the current algorithm in the backup.

See Also:

Constant Field Values

m_Algorithm

protected AbstractTimeseriesFeatureGenerator m_Algorithm

the feature generator to use.

m_ActualAlgorithm

protected transient AbstractTimeseriesFeatureGenerator m_ActualAlgorithm

the actual algorithm to apply to the image.

m_VariableName

protected VariableName m_VariableName

the variable to listen to.

m_Queue

protected ArrayList m_Queue

the generated objects.

Constructor Detail

TimeseriesFeatureGenerator

public TimeseriesFeatureGenerator()

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 AbstractActor

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractActor

setAlgorithm

public void setAlgorithm(AbstractTimeseriesFeatureGenerator value)

Sets the algorithm to use.

Specified by:

setAlgorithm in interface FeatureGenerator<AbstractTimeseriesFeatureGenerator>

Parameters:

value - the algorithm

getAlgorithm

public AbstractTimeseriesFeatureGenerator getAlgorithm()

Returns the algorithm in use.

Specified by:

getAlgorithm in interface FeatureGenerator<AbstractTimeseriesFeatureGenerator>

Returns:

the algorithm

algorithmTipText

public String algorithmTipText()

Returns the tip text for this property.

Specified by:

algorithmTipText in interface FeatureGenerator<AbstractTimeseriesFeatureGenerator>

Returns:

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

setVariableName

public void setVariableName(VariableName value)

Sets the name of the variable to monitor.

Specified by:

setVariableName in interface VariableMonitor

Parameters:

value - the name

getVariableName

public VariableName getVariableName()

Returns the name of the variable to monitor.

Specified by:

getVariableName in interface VariableMonitor

Returns:

the name

variableNameTipText

public String variableNameTipText()

Returns the tip text for this property.

Specified by:

variableNameTipText in interface VariableMonitor

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 actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

See Also:

AbstractActor.reset()

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractTransformer

Returns:

the backup

See Also:

AbstractActor.updateVariables(), AbstractActor.restoreState(Hashtable)

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractTransformer

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

variableChanged

public void variableChanged(VariableChangeEvent e)

Gets triggered when a variable changed (added, modified, removed).

Specified by:

variableChanged in interface Actor

Specified by:

variableChanged in interface VariableChangeListener

Overrides:

variableChanged in class AbstractActor

Parameters:

e - the event

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

adams.data.spreadsheet.Row.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Overrides:

hasPendingOutput in class AbstractTransformer

Returns:

true if there is pending output

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Overrides:

output in class AbstractTransformer

Returns:

the generated token

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractTransformer