|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.AbleObject | +--com.ibm.able.beans.AbleTimeSeriesFilter
The AbleTimeSeriesFilter is intended for use in the AbleNeuralPredictionAgent. It collects a set of inputBuffers so that a model can use more than one period's data in its calculations. Only all numeric data is supported.
The number of periods used in the calculation is termed the windowSize. If each record has n input fields and m periods are specified, the bean's output will be of size n x m plus the number of output values forecast. Default value is 1.
The number of periods in the future to predict is the horizon. The default value is zero, which means the target output value will be read from the last record in the window. A horizon value of 1 means to predict the next period.
A window and horizon setting of 1 and 0 means the filter does not manipulate the input stream.
Field Summary | |
---|---|
static java.lang.String |
defaultName
Value assigned to name by default. |
protected int |
horizon
|
protected double[] |
inNum
|
protected boolean |
loaded
|
protected int |
numInUnits
|
protected int |
numOutUnits
|
protected double[] |
outNum
|
protected int |
recInx
|
protected static long |
serialVersionUID
Serialized version identifier in form YYYYMMDDVerRelModxx |
protected double[] |
tmpNum
|
protected int |
totalOutUnits
|
protected int |
totalTmpUnits
|
protected int |
windowSize
|
Fields inherited from class com.ibm.able.AbleObject |
---|
changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport, trace |
Constructor Summary | |
---|---|
AbleTimeSeriesFilter()
Construct a default AbleTimeSeriesFilter. |
|
AbleTimeSeriesFilter(java.lang.String name)
Construct an AbleTimeSeriesFilter object with specified name. |
Method Summary | |
---|---|
static java.lang.String |
Copyright()
Determine the copyright of this class. |
int |
getHorizon()
Get the horizon, the number of periods in the future to predict. |
int |
getNumInUnits()
Get the number of input units. |
int |
getNumOutUnits()
Get the number of output units. |
int |
getWindowSize()
Get the windowSize, the number of periods to be used in the forecast. |
void |
init()
Allocate the arrays used to store data based on the windowSize, horizon, numInUnits, and numOutUnits per record. |
boolean |
isLoaded()
Returns true if the filter has been loaded with data and is ready for processing (output buffer is valid) |
void |
process()
Performs the main, synchronous, standard processing function performed by this bean. |
void |
reset()
Reset the time series filter. |
void |
setHorizon(int horizon)
Set the horizon, the number of periods in the future to predict. |
void |
setNumInUnits(int numInUnits)
Set the number of input units. |
void |
setNumOutUnits(int numOutUnits)
Set the number of output units. |
void |
setWindowSize(int windowSize)
Set the windowSize, the number of periods to be used in the forecast. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String defaultName
protected static final long serialVersionUID
protected double[] inNum
protected double[] outNum
protected double[] tmpNum
protected int windowSize
protected int horizon
protected int numInUnits
protected int numOutUnits
protected int totalTmpUnits
protected int totalOutUnits
protected int recInx
protected boolean loaded
Constructor Detail |
public AbleTimeSeriesFilter() throws AbleException
public AbleTimeSeriesFilter(java.lang.String name) throws AbleException
name
- A String containing the name used to identify this bean.Method Detail |
public void setWindowSize(int windowSize)
public int getWindowSize()
public void setHorizon(int horizon)
public int getHorizon()
public void setNumInUnits(int numInUnits)
public int getNumInUnits()
public void setNumOutUnits(int numOutUnits)
public int getNumOutUnits()
public boolean isLoaded()
public void init() throws AbleException
Note: default windowSize=1, horizon=0 means record is just passed through without any internal buffering
init
in class AbleObject
com.ibm.able.AbleObject
AbleException
- If an error occurs.AbleObject.startEnabledEventProcessing()
public void process() throws AbleException
AbleObject
This base method implementation provides tracing only.
process
in class AbleObject
com.ibm.able.AbleObject
AbleObject.inputBuffer
,
AbleObject.outputBuffer
,
AbleBean.process()
public void reset() throws AbleException
reset
in class AbleObject
com.ibm.able.AbleObject
AbleException
- If an error occurs.AbleBean.reset()
public static java.lang.String Copyright()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |