org.openimaj.ml.timeseries.collection

Class TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES extends TimeSeriesCollection<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>

Type Parameters:

ALLINPUT - The collection input type

SINGLEINPUT - The type of a single data type

TIMESERIES - the type of time series returned

INTERNALSERIES - the type of time series held

All Implemented Interfaces:

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

Direct Known Subclasses:

DoubleTimeSeriesCollection, SynchronisedTimeSeriesCollection, WordDFIDFTimeSeriesCollection

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

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

Modifier and Type	Field and Description
protected HashMap<String,INTERNALSERIES>	timeSeriesHolder

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTimeSeries(String name, INTERNALSERIES series)
Collection<INTERNALSERIES>	allseries()
TIMESERIES	collectionByNames(Collection<String> names)
TIMESERIES	collectionByNames(String... names)
<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS extends TimeSeries<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS>,OUTPUTTSC extends TimeSeriesCollection<OUTPUTALL,OUTPUTSINGLE,OUTPUTTSC,OUTPUTTS>> OUTPUTTSC	convertInternal(TimeSeriesConverter<ALLINPUT,SINGLEINPUT,INTERNALSERIES,OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsc, OUTPUTTSC inst)
<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS extends TimeSeries<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS>,OUTPUTTSC extends TimeSeriesCollection<OUTPUTALL,OUTPUTSINGLE,OUTPUTTSC,OUTPUTTS>> OUTPUTTSC	convertInternal(TimeSeriesConverter<ALLINPUT,SINGLEINPUT,INTERNALSERIES,OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsc, TimeSeriesProcessor<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsp, OUTPUTTSC inst)
TIMESERIES	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.
TIMESERIES	get(long time, int nbefore, int nafter, TIMESERIES 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.
TIMESERIES	get(long start, long end) returns the RETURNTYPE between the specified time periods.
TIMESERIES	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.
Map<String,ALLINPUT>	getData()
Set<String>	getNames()
long[]	getTimes()
abstract INTERNALSERIES	internalNewInstance()
Iterator<IndependentPair<Long,Map<String,SINGLEINPUT>>>	iterator()
int	nSeries()
TIMESERIES	processInternal(TimeSeriesProcessor<ALLINPUT,SINGLEINPUT,INTERNALSERIES> tsp) process the internal series held by this collection with this processor
TIMESERIES	processInternalInplace(TimeSeriesProcessor<ALLINPUT,SINGLEINPUT,INTERNALSERIES> tsp) process the internal series held by this collection with this processor
INTERNALSERIES	series(String name)
void	set(long[] time, Map<String,ALLINPUT> data) Set the data associated with each time.
int	size()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

timeSeriesHolder

protected HashMap<String,INTERNALSERIES extends TimeSeries<ALLINPUT,SINGLEINPUT,INTERNALSERIES>> timeSeriesHolder

Constructor Detail

TimeSeriesCollection

public TimeSeriesCollection()

initialise the underlying time series holder

Method Detail

addTimeSeries

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

Parameters:

name -

series -

Throws:

IncompatibleTimeSeriesException

series

public INTERNALSERIES series(String name)

Parameters:

name - the name of the series

Returns:

the series held by the name

allseries

public Collection<INTERNALSERIES> allseries()

Returns:

all the time series held

get

public TIMESERIES 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<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

Returns:

all data found with these parameters

getData

public Map<String,ALLINPUT> getData()

Specified by:

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

Returns:

all data

get

public TIMESERIES 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<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

Returns:

all data found with these parameters

get

public TIMESERIES get(long time,
             int nbefore,
             int nafter,
             TIMESERIES 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<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

Returns:

all data found with these parameters

internalNewInstance

public abstract INTERNALSERIES internalNewInstance()

Returns:

an instance of the internal series held

get

public TIMESERIES 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<Map<String,ALLINPUT>,Map<String,SINGLEINPUT>,TIMESERIES extends TimeSeriesCollection<ALLINPUT,SINGLEINPUT,TIMESERIES,INTERNALSERIES>>

Returns:

all data found with these parameters

collectionByNames

public TIMESERIES collectionByNames(String... names)

Parameters:

names -

Returns:

a new time series containing sub time series by name

collectionByNames

public TIMESERIES collectionByNames(Collection<String> names)

Parameters:

names -

Returns:

a new time series containing sub time series by name

getNames

public Set<String> getNames()

Returns:

the set of names of the time series in this collection

nSeries

public int nSeries()

Returns:

number of series held

processInternal

public TIMESERIES processInternal(TimeSeriesProcessor<ALLINPUT,SINGLEINPUT,INTERNALSERIES> tsp)

process the internal series held by this collection with this processor

Parameters:

tsp -

Returns:

a new instance of each internal series held in the same type of collection

processInternalInplace

public TIMESERIES processInternalInplace(TimeSeriesProcessor<ALLINPUT,SINGLEINPUT,INTERNALSERIES> tsp)

process the internal series held by this collection with this processor

Parameters:

tsp -

Returns:

each held instance processed

convertInternal

public <OUTPUTALL,OUTPUTSINGLE,OUTPUTTS extends TimeSeries<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS>,OUTPUTTSC extends TimeSeriesCollection<OUTPUTALL,OUTPUTSINGLE,OUTPUTTSC,OUTPUTTS>> OUTPUTTSC convertInternal(TimeSeriesConverter<ALLINPUT,SINGLEINPUT,INTERNALSERIES,OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsc,
                                                                                                                                                                                                OUTPUTTSC inst)

Type Parameters:

OUTPUTALL -

OUTPUTSINGLE -

OUTPUTTS -

OUTPUTTSC -

Parameters:

tsc - the method to convert each item

inst - the instance to be filled

Returns:

the inputed instance for convenience

convertInternal

public <OUTPUTALL,OUTPUTSINGLE,OUTPUTTS extends TimeSeries<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS>,OUTPUTTSC extends TimeSeriesCollection<OUTPUTALL,OUTPUTSINGLE,OUTPUTTSC,OUTPUTTS>> OUTPUTTSC convertInternal(TimeSeriesConverter<ALLINPUT,SINGLEINPUT,INTERNALSERIES,OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsc,
                                                                                                                                                                                                TimeSeriesProcessor<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS> tsp,
                                                                                                                                                                                                OUTPUTTSC inst)

Type Parameters:

OUTPUTALL -

OUTPUTSINGLE -

OUTPUTTS -

OUTPUTTSC -

Parameters:

tsc - the method to convert each item

tsp - a processor to apply during conversion

inst - the instance to be filled

Returns:

the inputed instance for convenience

iterator

public Iterator<IndependentPair<Long,Map<String,SINGLEINPUT>>> iterator()

getTimes

public long[] getTimes()

Specified by:

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

Returns:

all times

size

public int size()

Specified by:

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

Returns:

the number of valid time steps in this timeseries

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

Specified by:

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

Parameters:

time - instances of time

data - instances of data

Throws:

TimeSeriesSetException