Supported Indicators

Time Series Forecast

Introduction

This indicator represents an indicator capable of predicting new values given previous data from a window. source

To view the implementation of this indicator, see the LEAN GitHub repository.

Using TSF Indicator

To create an automatic indicators for TimeSeriesForecast, call the TSF helper method from the QCAlgorithm class. The TSF method creates a TimeSeriesForecast object, hooks it up for automatic updates, and returns it so you can used it in your algorithm. In most cases, you should call the helper method in the Initializeinitialize method.

public class TimeSeriesForecastAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private TimeSeriesForecast _tsf;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _tsf = TSF(_symbol, 3);
    }

    public override void OnData(Slice data)
    {
        if (_tsf.IsReady)
        {
            // The current value of _tsf is represented by itself (_tsf)
            // or _tsf.Current.Value
            Plot("TimeSeriesForecast", "tsf", _tsf);
            
        }
    }
}
class TimeSeriesForecastAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._tsf = self.tsf(self._symbol, 3)

    def on_data(self, slice: Slice) -> None:
        if self._tsf.is_ready:
            # The current value of self._tsf is represented by self._tsf.current.value
            self.plot("TimeSeriesForecast", "tsf", self._tsf.current.value)
            

The following reference table describes the TSF method:

tsf(symbol, period, resolution=None, selector=None)[source]

Creates a new Time Series Forecast indicator

Parameters:
  • symbol (Symbol) — The symbol whose TSF we want
  • period (int) — The period of the TSF
  • resolution (Resolution, optional) — The resolution
  • selector (Callable[IBaseData, float], optional) — x.Value)
Returns:

The TimeSeriesForecast indicator for the requested symbol over the specified period

Return type:

TimeSeriesForecast

TSF(symbol, period, resolution=None, selector=None)[source]

Creates a new Time Series Forecast indicator

Parameters:
  • symbol (Symbol) — The symbol whose TSF we want
  • period (Int32) — The period of the TSF
  • resolution (Resolution, optional) — The resolution
  • selector (Func<IBaseData, Decimal>, optional) — x.Value)
Returns:

The TimeSeriesForecast indicator for the requested symbol over the specified period

Return type:

TimeSeriesForecast

If you don't provide a resolution, it defaults to the security resolution. If you provide a resolution, it must be greater than or equal to the resolution of the security. For instance, if you subscribe to hourly data for a security, you should update its indicator with data that spans 1 hour or longer.

For more information about the selector argument, see Alternative Price Fields.

For more information about plotting indicators, see Plotting Indicators.

You can manually create a TimeSeriesForecast indicator, so it doesn't automatically update. Manual indicators let you update their values with any data you choose.

Updating your indicator manually enables you to control when the indicator is updated and what data you use to update it. To manually update the indicator, call the Updateupdate method with time/number pair or an IndicatorDataPoint. The indicator will only be ready after you prime it with enough data.

public class TimeSeriesForecastAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private TimeSeriesForecast _tsf;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _tsf = new TimeSeriesForecast(3);
    }

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGetValue(_symbol, out var bar))
        {      
            _tsf.Update(bar.EndTime, bar.Close);
        }
   
        if (_tsf.IsReady)
        {
            // The current value of _tsf is represented by itself (_tsf)
            // or _tsf.Current.Value
            Plot("TimeSeriesForecast", "tsf", _tsf);
            
        }
    }
}
class TimeSeriesForecastAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._tsf = TimeSeriesForecast(3)

    def on_data(self, slice: Slice) -> None:
        bar = slice.bars.get(self._symbol)
        if bar:
            self._tsf.update(bar.EndTime, bar.Close)
        if self._tsf.is_ready:
            # The current value of self._tsf is represented by self._tsf.current.value
            self.plot("TimeSeriesForecast", "tsf", self._tsf.current.value)
            

To register a manual indicator for automatic updates with the security data, call the RegisterIndicatorregister_indicator method.

public class TimeSeriesForecastAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private TimeSeriesForecast _tsf;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _tsf = new TimeSeriesForecast(3);
        RegisterIndicator(_symbol, _tsf, Resolution.Daily);
    }

    public override void OnData(Slice data)
    {
        if (_tsf.IsReady)
        {
            // The current value of _tsf is represented by itself (_tsf)
            // or _tsf.Current.Value
            Plot("TimeSeriesForecast", "tsf", _tsf);
            
        }
    }
}
class TimeSeriesForecastAlgorithm(QCAlgorithm):
    def initialize(self) -> None:
        self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol
        self._tsf = TimeSeriesForecast(3)
        self.register_indicator(self._symbol, self._tsf, Resolution.DAILY)

    def on_data(self, slice: Slice) -> None:
        if self._tsf.is_ready:
            # The current value of self._tsf is represented by self._tsf.current.value
            self.plot("TimeSeriesForecast", "tsf", self._tsf.current.value)
            

The following reference table describes the TimeSeriesForecast constructor:

TimeSeriesForecast

class QuantConnect.Indicators.TimeSeriesForecast[source]

Represents an indicator capable of predicting new values given previous data from a window. Source: https://tulipindicators.org/tsf

get_enumerator()

Returns an enumerator that iterates through the history window.

Return type:

IEnumerator[IndicatorDataPoint]

reset()

Resets this indicator to its initial state

to_detailed_string()

Provides a more detailed string of this indicator in the form of {Name} - {Value}

Return type:

str

update(time, value)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • time (datetime)
  • value (float)
Return type:

bool

update(input)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • input (IBaseData)
Return type:

bool

property consolidators

The data consolidators associated with this indicator if any

Returns:

The data consolidators associated with this indicator if any

Return type:

ISet[IDataConsolidator]

property current

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property is_ready

Gets a flag indicating when this indicator is ready and fully initialized

Returns:

Gets a flag indicating when this indicator is ready and fully initialized

Return type:

bool

property item

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Returns:

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Return type:

IndicatorDataPoint

property name

Gets a name for this indicator

Returns:

Gets a name for this indicator

Return type:

str

property period

Gets the period of this window indicator

Returns:

Gets the period of this window indicator

Return type:

int

property previous

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property samples

Gets the number of samples processed by this indicator

Returns:

Gets the number of samples processed by this indicator

Return type:

int

property warm_up_period

Required period, in data points, to the indicator to be ready and fully initialized

Returns:

Required period, in data points, to the indicator to be ready and fully initialized

Return type:

int

property window

A rolling window keeping a history of the indicator values of a given period

Returns:

A rolling window keeping a history of the indicator values of a given period

Return type:

RollingWindow[IndicatorDataPoint]

TimeSeriesForecast

class QuantConnect.Indicators.TimeSeriesForecast[source]

Represents an indicator capable of predicting new values given previous data from a window. Source: https://tulipindicators.org/tsf

GetEnumerator()

Returns an enumerator that iterates through the history window.

Return type:

IEnumerator[IndicatorDataPoint]

Reset()

Resets this indicator to its initial state

ToDetailedString()

Provides a more detailed string of this indicator in the form of {Name} - {Value}

Return type:

String

Update(time, value)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • time (DateTime)
  • value (decimal)
Return type:

Boolean

Update(input)

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters:
  • input (IBaseData)
Return type:

Boolean

property Consolidators

The data consolidators associated with this indicator if any

Returns:

The data consolidators associated with this indicator if any

Return type:

ISet<IDataConsolidator>

property Current

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property IsReady

Gets a flag indicating when this indicator is ready and fully initialized

Returns:

Gets a flag indicating when this indicator is ready and fully initialized

Return type:

bool

property Name

Gets a name for this indicator

Returns:

Gets a name for this indicator

Return type:

string

property Period

Gets the period of this window indicator

Returns:

Gets the period of this window indicator

Return type:

Int32

property Previous

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Returns:

Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Return type:

IndicatorDataPoint

property Samples

Gets the number of samples processed by this indicator

Returns:

Gets the number of samples processed by this indicator

Return type:

int

property WarmUpPeriod

Required period, in data points, to the indicator to be ready and fully initialized

Returns:

Required period, in data points, to the indicator to be ready and fully initialized

Return type:

Int32

property Window

A rolling window keeping a history of the indicator values of a given period

Returns:

A rolling window keeping a history of the indicator values of a given period

Return type:

RollingWindow<IndicatorDataPoint>

property [System.Int32]

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Returns:

Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.

Return type:

IndicatorDataPoint

Visualization

The following image shows plot values of selected properties of TimeSeriesForecast using the plotly library.

TimeSeriesForecast line plot.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: