Indicator Reference

Sum

Introduction

This indicator represents an indicator capable of tracking the sum for the given period

Create Manual Indicators

You can manually create a Sum indicator, so it doesn’t automatically update. Manual indicators let you update their values with any data you choose. The following reference table describes the Sum constructor.

Sum()1/2

            Sum QuantConnect.Indicators.Sum (
     string  name,
     int     period
   )
        

Initializes a new instance of the Sum class with the specified name and period.

Sum()2/2

            Sum QuantConnect.Indicators.Sum (
     int  period
   )
        

Initializes a new instance of the Sum class with the default name and period.

Update Manual Indicators

You can update the indicator automatically or manually.

Automatic Update

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


private Sum _sum;

// In Initialize()
_sum = new Sum(name, period);
_sum.Updated += IndicatorUpdateMethod;

RegisterIndicator(symbol, _sum, Resolution.Daily);

// In IndicatorUpdateMethod()
if (_sum.IsReady)
{
    var indicatorValue = _sum.Current.Value;
}
    
# In Initialize()
self.sum = Sum(name, period)
self.sum.Updated += self.IndicatorUpdateMethod

self.RegisterIndicator(symbol, self.sum, Resolution.Daily)

# In IndicatorUpdateMethod()
if self.sum.IsReady:
    indicator_value = self.sum.Current.Value

To customize the data that automatically updates the indicator, see Custom Indicator Periods and Custom Indicator Values.

Manual Update

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 Update method with time/decimal pair. The indicator will only be ready after you prime it with enough data.

    
private Sum _sum;
private Symbol symbol;

// In Initialize()
_sum = new Sum(period);
symbol = AddEquity("SPY").Symbol;

// In OnData()
if (data.ContainsKey(_symbol))
{
    _sum.Update(data[symbol].EndTime, data[symbol].High);
}
if (_sum.IsReady)
{
    var indicatorValue = _sum.Current.Value;
}
    
# In Initialize()
self.sum = Sum(period)
self.symbol = self.AddEquity("SPY").Symbol

# In OnData()
if data.ContainsKey(self.symbol):
    self.sum.Update(data[self.symbol].EndTime, data[self.symbol].High)
if self.sum.IsReady:
    indicator_value = self.sum.Current.Value

Create Automatic Indicators

The SUM method creates an Sum indicator, sets up a consolidator to update the indicator, and then returns the indicator so you can use it in your algorithm.

The following reference table describes the SUM method:

SUM()1/1

            Sum QuantConnect.Algorithm.QCAlgorithm.SUM (
    Symbol                           symbol,
    Int32                            period,
    *Nullable<Resolution>      resolution,
    *Func<IBaseData, Decimal>  selector
   )
        

Creates a new Sum indicator.


If you don't provide a resolution, it defauls 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.

Get Indicator Values

To get the value of the indicator, use its Current.Value attribute.

private Sum _sum;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_sum = SUM(symbol, period);

// In OnData()
if (_sum.IsReady)
{
    var current = _sum.Current.Value;
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.sum = self.SUM(symbol, period)

# In OnData()
if self.sum.IsReady:
    current = self.sum.Current.Value

Visualization

To plot indicator values, in the OnData event handler, call the Plot method.

private Sum _sum;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_sum = SUM(symbol, period);

// In OnData()
if (_sum.IsReady)
{
    Plot("My Indicators", "sum", _sum.Current);
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.sum = self.SUM(symbol, period)

# In OnData()
if self.sum.IsReady:
    self.Plot("My Indicators", "sum", self.sum.Current)

For more information about plotting indicators, see Plotting Indicators.

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: