org.openimaj.ml.timeseries.processor.interpolation

Class TimeSeriesInterpolation

java.lang.Object

org.openimaj.ml.timeseries.processor.interpolation.TimeSeriesInterpolation

All Implemented Interfaces:

TimeSeriesProcessor<double[],Double,DoubleTimeSeries>

Direct Known Subclasses:

LinearInterpolationProcessor

public abstract class TimeSeriesInterpolation
extends Object
implements TimeSeriesProcessor<double[],Double,DoubleTimeSeries>

Interpolate values of a time series. Useful for filling in missing values and homogonising disperate sets of TimeSeries data

Author:

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

Constructor Summary

Constructors

Constructor and Description
TimeSeriesInterpolation() The processor's times are set to default, i.e.
TimeSeriesInterpolation(long[] times)
TimeSeriesInterpolation(long begin, int steps, long delta)
TimeSeriesInterpolation(long begin, long end, int steps)
TimeSeriesInterpolation(long begin, long end, long delta)

Method Summary

Modifier and Type	Method and Description
DoubleTimeSeries	interpolate(DoubleTimeSeries series)
abstract DoubleTimeSeries	interpolate(DoubleTimeSeries series, long[] times)
DoubleTimeSeries	interpolate(DoubleTimeSeries series, long begin, int steps, long delta) Uses interpolate(DoubleTimeSeries, long[]) to return an interpolation of the construction TimeSeries from begin, for a number of steps with a given delta between steps
DoubleTimeSeries	interpolate(DoubleTimeSeries series, long begin, long end, int splits) Uses interpolate(DoubleTimeSeries,long[]) to return an interpolation of the construction TimeSeries from begin, until end with a delta which means that there are splits time instances
DoubleTimeSeries	interpolate(DoubleTimeSeries series, long begin, long end, long delta) Uses interpolate(DoubleTimeSeries, long[]) to return an interpolation of the construction TimeSeries between the times at the required interval
void	process(DoubleTimeSeries ts)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesInterpolation

public TimeSeriesInterpolation()

The processor's times are set to default, i.e. from min to max time in steps of 1 long

TimeSeriesInterpolation

public TimeSeriesInterpolation(long begin,
                               long end,
                               long delta)

Parameters:

begin -

end -

delta -

TimeSeriesInterpolation

public TimeSeriesInterpolation(long begin,
                               int steps,
                               long delta)

Parameters:

begin -

steps -

delta -

TimeSeriesInterpolation

public TimeSeriesInterpolation(long begin,
                               long end,
                               int steps)

Parameters:

begin - the start of the new time series

end - the end of the new time series

steps - the steps between (begin = 0, end = 10, 6 steps will give 0, 2, 4, 6, 8, 10

TimeSeriesInterpolation

public TimeSeriesInterpolation(long[] times)

Parameters:

times - the times used by the processor

Method Detail

interpolate

public DoubleTimeSeries interpolate(DoubleTimeSeries series,
                                    long begin,
                                    long end,
                                    long delta)

Uses interpolate(DoubleTimeSeries, long[]) to return an interpolation of the construction TimeSeries between the times at the required interval

Parameters:

series -

begin - time to start

end - time to end

delta - the delta between time steps

Returns:

DoubleTimeSeries instance interpolated from the construction TimeSeries instance

interpolate

public DoubleTimeSeries interpolate(DoubleTimeSeries series,
                                    long begin,
                                    int steps,
                                    long delta)

Uses interpolate(DoubleTimeSeries, long[]) to return an interpolation of the construction TimeSeries from begin, for a number of steps with a given delta between steps

Parameters:

series -

begin -

steps -

delta -

Returns:

DoubleTimeSeries instance interpolated from the construction TimeSeries instance

interpolate

public DoubleTimeSeries interpolate(DoubleTimeSeries series,
                                    long begin,
                                    long end,
                                    int splits)

Uses interpolate(DoubleTimeSeries,long[]) to return an interpolation of the construction TimeSeries from begin, until end with a delta which means that there are splits time instances

Parameters:

series -

begin -

end -

splits -

Returns:

DoubleTimeSeries instance interpolated from the construction TimeSeries instance

interpolate

public DoubleTimeSeries interpolate(DoubleTimeSeries series)

Parameters:

series -

Returns:

a new DoubleTimeSeries interpolated with times provided in the constructor

interpolate

public abstract DoubleTimeSeries interpolate(DoubleTimeSeries series,
                                             long[] times)

Parameters:

series -

times - might be null, therefore some "defualt" time step should be used

Returns:

DoubleTimeSeries instance interpolated from the construction TimeSeries instance

process

public void process(DoubleTimeSeries ts)

Specified by:

process in interface TimeSeriesProcessor<double[],Double,DoubleTimeSeries>

Parameters:

ts - alter this time series in place