com.github.brandtg.stl

Class StlResult

java.lang.Object

com.github.brandtg.stl.StlResult

public class StlResult
extends Object

The STL decomposition of a time series.

getData() == getTrend() + getSeasonal() + getRemainder()

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StlResult(double[] times, double[] series, double[] trend, double[] seasonal, double[] remainder) Constructed by running StlDecomposition.

Method Summary

Modifier and Type	Method and Description
double[]	getRemainder()
double[]	getSeasonal()
double[]	getSeries()
double[]	getTimes()
double[]	getTrend()

Methods inherited from class java.lang.Object

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

Constructor Detail

StlResult

protected StlResult(double[] times,
                    double[] series,
                    double[] trend,
                    double[] seasonal,
                    double[] remainder)

Constructed by running StlDecomposition.

Parameters:

times - The input times array.

series - The input series.

trend - The output trend component of series.

seasonal - The output seasonal component of series.

remainder - The output remainder component of series.

Method Detail

getTimes

public double[] getTimes()

Returns:

The input times array, for convenience.

getSeries

public double[] getSeries()

Returns:

The input series array, for convenience.

getTrend

public double[] getTrend()

Returns:

The trend component of series.

getSeasonal

public double[] getSeasonal()

Returns:

The seasonal component of series.

getRemainder

public double[] getRemainder()

Returns:

The remainder component of series.