org.openimaj.ml.timeseries.series

Class ConcreteTimeSeries<DATA,TS extends ConcreteTimeSeries<DATA,TS>>

java.lang.Object

org.openimaj.ml.timeseries.TimeSeries<DATA[],DATA,TS>

org.openimaj.ml.timeseries.series.ConcreteTimeSeries<DATA,TS>

Type Parameters:

DATA -

TS -

All Implemented Interfaces:

Iterable<IndependentPair<Long,DATA>>, TimeSeriesCollectionAssignable<DATA,TS>

Direct Known Subclasses:

WordDFIDFTimeSeries

public abstract class ConcreteTimeSeries<DATA,TS extends ConcreteTimeSeries<DATA,TS>>
extends TimeSeries<DATA[],DATA,TS>
implements TimeSeriesCollectionAssignable<DATA,TS>

A generic though inefficient time series which can be used by any data type. This implementation is backed by a treemap. Array construction is handled using ReflectionUtils.getTypeArguments(Class, Class). To use this class simple define a new class

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
ConcreteTimeSeries() Initialise the backing treemap

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long time, DATA value) Add an element to this time series
TS	get(long time, int nbefore, int nafter) returns the DATA at a specific point in time and those before and after to the number requested.
TS	get(long time, int nbefore, int nafter, TS output) Same as TimeSeries.get(long, int, int) but instead of createing the output DATA instance, an existing data instance is handed which is filled.
TS	get(long start, long end) returns the RETURNTYPE between the specified time periods.
TS	get(long time, long threshbefore, long threshafter) returns the RETURNTYPE at a specific point in time and those before and after within the specified thresholds.
DATA[]	getData()
long[]	getTimes()
void	internalAssign(Collection<Long> times, Collection<DATA> data) Assign these values of data and time to the internal collection
void	internalAssign(long[] times, DATA[] data)
void	internalAssign(TS assign)
Iterator<IndependentPair<Long,DATA>>	iterator()
TS	newInstance(Collection<Long> timeList, Collection<DATA> dataList)
void	set(long[] time, DATA[] data) Set the data associated with each time.
int	size()
String	toString()

Methods inherited from class org.openimaj.ml.timeseries.TimeSeries

convert, convert, copy, get, newInstance, process, processInplace

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcreteTimeSeries

public ConcreteTimeSeries()

Initialise the backing treemap

Method Detail

get

public TS get(long time,
     int nbefore,
     int nafter)

Description copied from class: TimeSeries

returns the DATA at a specific point in time and those before and after to the number requested. This method may not return data for the specific requested time if it does not exists. If the time series is completely empty this function may return at an empty array however if at least 1 data point exists and either nbefore and nafter are bigger than 1 then at least 1 datapoint will be returned.

Data should be returned in order

Specified by:

get in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all data found with these parameters

newInstance

public TS newInstance(Collection<Long> timeList,
             Collection<DATA> dataList)

Specified by:

newInstance in interface TimeSeriesCollectionAssignable<DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

a new instance of the time series based on the two collections

get

public TS get(long time,
     int nbefore,
     int nafter,
     TS output)

Description copied from class: TimeSeries

Same as TimeSeries.get(long, int, int) but instead of createing the output DATA instance, an existing data instance is handed which is filled. For convenience this output is also returned

Data should be returned in order

Specified by:

get in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all data found with these parameters

get

public TS get(long time,
     long threshbefore,
     long threshafter)

Description copied from class: TimeSeries

returns the RETURNTYPE at a specific point in time and those before and after within the specified thresholds. This method may not return data for the specific requested time if it does not exists. Similarly this method may return an empty array if no time data is available within the window specified.

Data should be returned in order

Specified by:

get in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all data found with these parameters

get

public TS get(long start,
     long end)

Description copied from class: TimeSeries

returns the RETURNTYPE between the specified time periods. This method may not return data for the specific requested time if it does not exists. Similarly this method may return an empty array if no time data is available within the window specified.

Data should be returned in order

Specified by:

get in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all data found with these parameters

add

public void add(long time,
       DATA value)

Add an element to this time series

Parameters:

time -

value -

set

public void set(long[] time,
       DATA[] data)

Description copied from class: TimeSeries

Set the data associated with each time. This function explicitly assumes that time.length == data.length and there exists a single data instance per time instance

Specified by:

set in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Parameters:

time - instances of time

data - instances of data

getTimes

public long[] getTimes()

Specified by:

getTimes in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all times

getData

public DATA[] getData()

Specified by:

getData in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

all data

size

public int size()

Specified by:

size in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Returns:

the number of valid time steps in this timeseries

internalAssign

public void internalAssign(TS assign)

Specified by:

internalAssign in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

Parameters:

assign - assign this timeseries to the internal one, efforts should be made to copy the data, not simply assign it

internalAssign

public void internalAssign(long[] times,
                  DATA[] data)

Overrides:

internalAssign in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

internalAssign

public void internalAssign(Collection<Long> times,
                  Collection<DATA> data)

Description copied from interface: TimeSeriesCollectionAssignable

Assign these values of data and time to the internal collection

Specified by:

internalAssign in interface TimeSeriesCollectionAssignable<DATA,TS extends ConcreteTimeSeries<DATA,TS>>

toString

public String toString()

Specified by:

toString in class TimeSeries<DATA[],DATA,TS extends ConcreteTimeSeries<DATA,TS>>

iterator

public Iterator<IndependentPair<Long,DATA>> iterator()

Specified by:

iterator in interface Iterable<IndependentPair<Long,DATA>>