Supported Indicators

Log Return

Introduction

This indicator represents the LogReturn indicator (LOGR) - log returns are useful for identifying price convergence/divergence in a given period - logr = log (current price / last price in period)

Create Manual Indicators

You can manually create a LogReturn 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 LogReturn constructor.

LogReturn()1/2

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

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

LogReturn()2/2

            LogReturn QuantConnect.Indicators.LogReturn (
     int  period
   )
        

Initializes a new instance of the LogReturn 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 LogReturn _logr;

// In Initialize()
_logr = new LogReturn(name, period);
_logr.Updated += IndicatorUpdateMethod;

RegisterIndicator(symbol, _logr, Resolution.Daily);

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

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

# In IndicatorUpdateMethod()
if self.logr.IsReady:
    indicator_value = self.logr.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 LogReturn _logr;
private Symbol symbol;

// In Initialize()
_logr = new LogReturn(period);
symbol = AddEquity("SPY").Symbol;

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

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

Create Automatic Indicators

The LOGR method creates an LogReturn 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 LOGR method:

LOGR()1/1

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

Creates a new LogReturn indicator.


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.

Get Indicator Values

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

private LogReturn _logr;

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

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

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

Visualization

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

private LogReturn _logr;

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

// In OnData()
if (_logr.IsReady)
{
    Plot("My Indicators", "logreturn", _logr.Current);
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.logr = self.LOGR(symbol, period)

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

The following image shows the plot values in a matplotlib plot. To load algorithm plot data into the Research Environment, see Charts.

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: