org.openimaj.ml.timeseries.series

Class DoubleTimeSeries

java.lang.Object

org.openimaj.ml.timeseries.TimeSeries<double[],Double,DoubleTimeSeries>

org.openimaj.ml.timeseries.series.DoubleTimeSeries

All Implemented Interfaces:

Iterable<IndependentPair<Long,Double>>, ReadableASCII, ReadWriteableASCII, WriteableASCII, TimeSeriesCollectionAssignable<Double,DoubleTimeSeries>, DoubleTimeSeriesProvider, TimeSeriesArithmaticOperator<Double,DoubleTimeSeries>

public class DoubleTimeSeries
extends TimeSeries<double[],Double,DoubleTimeSeries>
implements TimeSeriesArithmaticOperator<Double,DoubleTimeSeries>, ReadWriteableASCII, TimeSeriesCollectionAssignable<Double,DoubleTimeSeries>, DoubleTimeSeriesProvider

Author:

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

Constructor Summary

Constructors

Constructor and Description
DoubleTimeSeries() Sets the times and data arrays backing this class 0 length
DoubleTimeSeries(int i) Convenience constructor, makes a time series with empty data of a given size
DoubleTimeSeries(long[] times, double[] data)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
DoubleTimeSeries	doubleTimeSeries()
DoubleTimeSeries	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.
DoubleTimeSeries	get(long time, int nbefore, int nafter, DoubleTimeSeries 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.
DoubleTimeSeries	get(long start, long end) returns the RETURNTYPE between the specified time periods.
DoubleTimeSeries	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.
double[]	getData()
long[]	getTimes()
void	internalAssign(Collection<Long> time, Collection<Double> data) Assign these values of data and time to the internal collection
void	internalAssign(DoubleTimeSeries interpolate)
void	internalAssign(long[] times, double[] data)
Iterator<IndependentPair<Long,Double>>	iterator()
DoubleTimeSeries	newInstance()
DoubleTimeSeries	newInstance(Collection<Long> time, Collection<Double> data)
void	readASCII(Scanner in) Read internal state from in.
void	set(long[] times, double[] data) Set the data associated with each time.
int	size()
Double	sum() add together all time series data elements
String	toString()
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
Double	zero()

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

convert, convert, copy, get, 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

DoubleTimeSeries

public DoubleTimeSeries(int i)

Convenience constructor, makes a time series with empty data of a given size

Parameters:

i -

DoubleTimeSeries

public DoubleTimeSeries()

Sets the times and data arrays backing this class 0 length

DoubleTimeSeries

public DoubleTimeSeries(long[] times,
                        double[] data)

Parameters:

times -

data -

Method Detail

get

public DoubleTimeSeries 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<double[],Double,DoubleTimeSeries>

Returns:

all data found with these parameters

get

public DoubleTimeSeries get(long time,
                            int nbefore,
                            int nafter,
                            DoubleTimeSeries 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<double[],Double,DoubleTimeSeries>

Returns:

all data found with these parameters

get

public DoubleTimeSeries 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<double[],Double,DoubleTimeSeries>

Returns:

all data found with these parameters

get

public DoubleTimeSeries 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<double[],Double,DoubleTimeSeries>

Returns:

all data found with these parameters

set

public void set(long[] times,
                double[] 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<double[],Double,DoubleTimeSeries>

Parameters:

times - instances of time

data - instances of data

getTimes

public long[] getTimes()

Specified by:

getTimes in class TimeSeries<double[],Double,DoubleTimeSeries>

Returns:

all times

getData

public double[] getData()

Specified by:

getData in class TimeSeries<double[],Double,DoubleTimeSeries>

Returns:

all data

newInstance

public DoubleTimeSeries newInstance()

Specified by:

newInstance in class TimeSeries<double[],Double,DoubleTimeSeries>

Returns:

an empty new instance of this timeseries type

size

public int size()

Specified by:

size in class TimeSeries<double[],Double,DoubleTimeSeries>

Returns:

the number of valid time steps in this timeseries

internalAssign

public void internalAssign(DoubleTimeSeries interpolate)

Specified by:

internalAssign in class TimeSeries<double[],Double,DoubleTimeSeries>

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<double[],Double,DoubleTimeSeries>

iterator

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

Specified by:

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

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

newInstance

public DoubleTimeSeries newInstance(Collection<Long> time,
                                    Collection<Double> data)

Specified by:

newInstance in interface TimeSeriesCollectionAssignable<Double,DoubleTimeSeries>

Returns:

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

internalAssign

public void internalAssign(Collection<Long> time,
                           Collection<Double> data)

Description copied from interface: TimeSeriesCollectionAssignable

Assign these values of data and time to the internal collection

Specified by:

internalAssign in interface TimeSeriesCollectionAssignable<Double,DoubleTimeSeries>

internalAssign

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

Overrides:

internalAssign in class TimeSeries<double[],Double,DoubleTimeSeries>

zero

public Double zero()

Specified by:

zero in interface TimeSeriesArithmaticOperator<Double,DoubleTimeSeries>

Returns:

a 0 data for this time series

sum

public Double sum()

Description copied from interface: TimeSeriesArithmaticOperator

add together all time series data elements

Specified by:

sum in interface TimeSeriesArithmaticOperator<Double,DoubleTimeSeries>

Returns:

Addition of all time series

doubleTimeSeries

public DoubleTimeSeries doubleTimeSeries()

Specified by:

doubleTimeSeries in interface DoubleTimeSeriesProvider

Returns:

provide an instance of a double time series for this time series