Supported Indicators

Hilbert Transform

Introduction

This indicator computes the Hilbert Transform Indicator by John Ehlers. By using present and prior price differences, and some feedback, price values are split into their complex number components of real (inPhase) and imaginary (quadrature) parts. source

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

Using HilbertTransform Indicator

To create an automatic indicators for HilbertTransform, call the HilbertTransform helper method from the QCAlgorithm class. The HilbertTransform method creates a HilbertTransform 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 HilbertTransformAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private HilbertTransform _hilberttransform;

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _hilberttransform = HilbertTransform(SPY);
    }

    public override void OnData(Slice data)
    {
        if (_hilberttransform.IsReady)
        {
            // The current value of _hilberttransform is represented by itself (_hilberttransform)
            // or _hilberttransform.Current.Value
            Plot("HilbertTransform", "hilberttransform", _hilberttransform);
            // Plot all properties of hilberttransform
            Plot("HilbertTransform", "inphase", _hilberttransform.InPhase);
            Plot("HilbertTransform", "quadrature", _hilberttransform.Quadrature);
        }
    }
}
class HilbertTransformAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.hilberttransform = self.HilbertTransform(SPY)

    def OnData(self, slice: Slice) -> None:
        if self.hilberttransform.IsReady:
            # The current value of self.hilberttransform is represented by self.hilberttransform.Current.Value
            self.Plot("HilbertTransform", "hilberttransform", self.hilberttransform.Current.Value)
            # Plot all attributes of self.hilberttransform
            self.Plot("HilbertTransform", "inphase", self.hilberttransform.InPhase.Current.Value)
            self.Plot("HilbertTransform", "quadrature", self.hilberttransform.Quadrature.Current.Value)

The following reference table describes the HilbertTransform method:

Warning: include(/tmp/docs/aed3a353ae3cb40c136495d01b681e19c0dc8281/Resources/qcalgorithm-api/hilberttransform.html): failed to open stream: No such file or directory in /tmp/docs/aed3a353ae3cb40c136495d01b681e19c0dc8281/Resources/indicators/using-indicator.php on line 49 Warning: include(): Failed opening '/tmp/docs/aed3a353ae3cb40c136495d01b681e19c0dc8281/Resources/qcalgorithm-api/hilberttransform.html' for inclusion (include_path='/var/www/beta/core/libraries/Google:/var/www/beta:.:/usr/share/php') in /tmp/docs/aed3a353ae3cb40c136495d01b681e19c0dc8281/Resources/indicators/using-indicator.php on line 49

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 HilbertTransform 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 time/number pair, or an IndicatorDataPoint. The indicator will only be ready after you prime it with enough data.

public class HilbertTransformAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private HilbertTransform _hilberttransform;

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

    public override void OnData(Slice data)
    {
        if (data.Bars.TryGeValue(_symbol, out var bar))
        {      
            _hilberttransform.Update(bar.EndTime, bar.Close);
        }

        if (_hilberttransform.IsReady)
        {
            // The current value of _hilberttransform is represented by itself (_hilberttransform)
            // or _hilberttransform.Current.Value
            Plot("HilbertTransform", "hilberttransform", _hilberttransform);
            // Plot all properties of hilberttransform
            Plot("HilbertTransform", "inphase", _hilberttransform.InPhase);
            Plot("HilbertTransform", "quadrature", _hilberttransform.Quadrature);
        }
    }
}
class HilbertTransformAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.hilberttransform = HilbertTransform(SPY)

    def OnData(self, slice: Slice) -> None:
        bar = slice.Bars.get(self.symbol)
        if bar:
            self.hilberttransform.Update(bar.EndTime, bar.Close)

        if self.hilberttransform.IsReady:
            # The current value of self.hilberttransform is represented by self.hilberttransform.Current.Value
            self.Plot("HilbertTransform", "hilberttransform", self.hilberttransform.Current.Value)
            # Plot all attributes of self.hilberttransform
            self.Plot("HilbertTransform", "inphase", self.hilberttransform.InPhase.Current.Value)
            self.Plot("HilbertTransform", "quadrature", self.hilberttransform.Quadrature.Current.Value)

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

public class HilbertTransformAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private HilbertTransform _hilberttransform;

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

    public override void OnData(Slice data)
    {
        if (_hilberttransform.IsReady)
        {
            // The current value of _hilberttransform is represented by itself (_hilberttransform)
            // or _hilberttransform.Current.Value
            Plot("HilbertTransform", "hilberttransform", _hilberttransform);
            // Plot all properties of hilberttransform
            Plot("HilbertTransform", "inphase", _hilberttransform.InPhase);
            Plot("HilbertTransform", "quadrature", _hilberttransform.Quadrature);
        }
    }
}
class HilbertTransformAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.hilberttransform = HilbertTransform(SPY)
        self.RegisterIndicator(self.symbol, self.hilberttransform, Resolution.Daily)

    def OnData(self, slice: Slice) -> None:
        if self.hilberttransform.IsReady:
            # The current value of self.hilberttransform is represented by self.hilberttransform.Current.Value
            self.Plot("HilbertTransform", "hilberttransform", self.hilberttransform.Current.Value)
            # Plot all attributes of self.hilberttransform
            self.Plot("HilbertTransform", "inphase", self.hilberttransform.InPhase.Current.Value)
            self.Plot("HilbertTransform", "quadrature", self.hilberttransform.Quadrature.Current.Value)

The following reference table describes the HilbertTransform constructor:

HilbertTransform()1/2

            HilbertTransform QuantConnect.Indicators.HilbertTransform (
    string  name
   )

Creates a new Hilbert Transform indicator.

HilbertTransform()2/2

            HilbertTransform QuantConnect.Indicators.HilbertTransform (
    
   )

Creates a new Hilbert Transform indicator with default name and default params.

Visualization

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

HilbertTransform 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: