Supported Indicators
Ultimate Oscillator
Introduction
This indicator computes the Ultimate Oscillator (ULTOSC) The Ultimate Oscillator is calculated as explained here: http://stockcharts.com/school/doku.php?id=chart_school:technical_indicators:ultimate_oscillator
To view the implementation of this indicator, see the LEAN GitHub repository.
Using ULTOSC Indicator
To create an automatic indicators for UltimateOscillator
, call the ULTOSC
helper method from the QCAlgorithm
class. The ULTOSC
method creates a UltimateOscillator
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 Initialize
method.
public class UltimateOscillatorAlgorithm : QCAlgorithm { private Symbol _symbol; private UltimateOscillator _ultosc; public override void Initialize() { _symbol = AddEquity("SPY", Resolution.Daily).Symbol; _ultosc = ULTOSC(_symbol, 5, 10, 20); } public override void OnData(Slice data) { if (_ultosc.IsReady) { // The current value of _ultosc is represented by itself (_ultosc) // or _ultosc.Current.Value Plot("UltimateOscillator", "ultosc", _ultosc); } } }
class UltimateOscillatorAlgorithm(QCAlgorithm): def Initialize(self) -> None: self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol self.ultosc = self.ULTOSC(self.symbol, 5, 10, 20) def OnData(self, slice: Slice) -> None: if self.ultosc.IsReady: # The current value of self.ultosc is represented by self.ultosc.Current.Value self.Plot("UltimateOscillator", "ultosc", self.ultosc.Current.Value)
The following reference table describes the ULTOSC
method:
ULTOSC()1/1
UltimateOscillator QuantConnect.Algorithm.QCAlgorithm.ULTOSC (Symbol
symbol,Int32
period1,Int32
period2,Int32
period3,*Nullable<Resolution>
resolution,*Func<IBaseData, IBaseDataBar>
selector )
Creates a new UltimateOscillator 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.
For more information about plotting indicators, see Plotting Indicators.
You can manually create a UltimateOscillator
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 Update
method with a TradeBar
, or QuoteBar
. The indicator will only be ready after you prime it with enough data.
public class UltimateOscillatorAlgorithm : QCAlgorithm { private Symbol _symbol; private UltimateOscillator _ultosc; public override void Initialize() { _symbol = AddEquity("SPY", Resolution.Daily).Symbol; _ultosc = new UltimateOscillator(5, 10, 20); } public override void OnData(Slice data) { if (data.Bars.TryGeValue(_symbol, out var bar)) { _ultosc.Update(bar); } if (_ultosc.IsReady) { // The current value of _ultosc is represented by itself (_ultosc) // or _ultosc.Current.Value Plot("UltimateOscillator", "ultosc", _ultosc); } } }
class UltimateOscillatorAlgorithm(QCAlgorithm): def Initialize(self) -> None: self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol self.ultosc = UltimateOscillator(5, 10, 20) def OnData(self, slice: Slice) -> None: bar = slice.Bars.get(self.symbol) if bar: self.ultosc.Update(bar) if self.ultosc.IsReady: # The current value of self.ultosc is represented by self.ultosc.Current.Value self.Plot("UltimateOscillator", "ultosc", self.ultosc.Current.Value)
To register a manual indicator for automatic updates with the security data, call the RegisterIndicator
method.
public class UltimateOscillatorAlgorithm : QCAlgorithm { private Symbol _symbol; private UltimateOscillator _ultosc; public override void Initialize() { _symbol = AddEquity("SPY", Resolution.Daily).Symbol; _ultosc = new UltimateOscillator(5, 10, 20); RegisterIndicator(_symbol, _ultosc, Resolution.Daily); } public override void OnData(Slice data) { if (_ultosc.IsReady) { // The current value of _ultosc is represented by itself (_ultosc) // or _ultosc.Current.Value Plot("UltimateOscillator", "ultosc", _ultosc); } } }
class UltimateOscillatorAlgorithm(QCAlgorithm): def Initialize(self) -> None: self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol self.ultosc = UltimateOscillator(5, 10, 20) self.RegisterIndicator(self.symbol, self.ultosc, Resolution.Daily) def OnData(self, slice: Slice) -> None: if self.ultosc.IsReady: # The current value of self.ultosc is represented by self.ultosc.Current.Value self.Plot("UltimateOscillator", "ultosc", self.ultosc.Current.Value)
The following reference table describes the UltimateOscillator
constructor:
UltimateOscillator()1/2
UltimateOscillator QuantConnect.Indicators.UltimateOscillator (int
period1,int
period2,int
period3 )
Initializes a new instance of the UltimateOscillator
class using the specified parameters.
UltimateOscillator()2/2
UltimateOscillator QuantConnect.Indicators.UltimateOscillator (string
name,int
period1,int
period2,int
period3 )
Initializes a new instance of the UltimateOscillator
class using the specified parameters.
Visualization
The following image shows plot values of selected properties of UltimateOscillator
using the plotly library.
