org.openimaj.ml.timeseries.collection

Class SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

java.lang.Object

org.openimaj.ml.timeseries.TimeSeries<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES>

org.openimaj.ml.timeseries.collection.TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>

org.openimaj.ml.timeseries.collection.SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>

Type Parameters:

ALLINPUT - The collection input type

SINGLEINPUT - The type of a single time point data

INTERNALSERIES - The type of the internal series held in this collection

TIMESERIES -

All Implemented Interfaces:

Iterable<IndependentPair<Long,Map<String,SINGLEINPUT>>>

Direct Known Subclasses:

DoubleSynchronisedTimeSeriesCollection

public abstract class SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>
extends TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>

A collection of time series which share exactly the same time steps. Given that this is true, SynchronisedTimeSeriesProcessor instances can perform interesting analysis

Author:

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

Field Summary

Fields inherited from class org.openimaj.ml.timeseries.collection.TimeSeriesCollection

timeSeriesHolder

Constructor Summary

Constructors

Constructor and Description
SynchronisedTimeSeriesCollection() initialise the underlying time series holder

Method Summary

Modifier and Type	Method and Description
void	addTimeSeries(String name, INTERNALSERIES series)
Collection<INTERNALSERIES>	allseries()
abstract ALLINPUT	flatten() In some way flatten the held time series such that the output is:
Map<String,ALLINPUT>	getData()
long[]	getTimes()
void	internalAssign(TIMESERIES interpolate)
INTERNALSERIES	series(String name)
void	set(long[] time, Map<String,ALLINPUT> data) Set the data associated with each time.
int	size()
String	toString()

Methods inherited from class org.openimaj.ml.timeseries.collection.TimeSeriesCollection

collectionByNames, collectionByNames, convertInternal, convertInternal, get, get, get, get, getNames, internalNewInstance, iterator, nSeries, processInternal, processInternalInplace

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SynchronisedTimeSeriesCollection

public SynchronisedTimeSeriesCollection()

initialise the underlying time series holder

Method Detail

addTimeSeries

public void addTimeSeries(String name,
                          INTERNALSERIES series)
                   throws IncompatibleTimeSeriesException

Overrides:

addTimeSeries in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Throws:

IncompatibleTimeSeriesException

series

public INTERNALSERIES series(String name)

Overrides:

series in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Parameters:

name - the name of the series

Returns:

the series held by the name

allseries

public Collection<INTERNALSERIES> allseries()

Overrides:

allseries in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Returns:

all the time series held

getTimes

public long[] getTimes()

Overrides:

getTimes in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Returns:

all times

set

public void set(long[] time,
                Map<String,ALLINPUT> data)
         throws TimeSeriesSetException

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

Overrides:

set in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Parameters:

time - instances of time

data - instances of data

Throws:

TimeSeriesSetException

getData

public Map<String,ALLINPUT> getData()

Overrides:

getData in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Returns:

all data

size

public int size()

Overrides:

size in class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>>

Returns:

the number of valid time steps in this timeseries

internalAssign

public void internalAssign(TIMESERIES interpolate)

Specified by:

internalAssign in class TimeSeries<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

Parameters:

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

toString

public String toString()

Specified by:

toString in class TimeSeries<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends SynchronisedTimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

flatten

public abstract ALLINPUT flatten()

In some way flatten the held time series such that the output is:

Returns:

[ALLDATAs1t1,ALLDATAs2t1,...,ALLDATAs1,t2,...,ALLDATAsntm] etc.