Candlestick Patterns

Mat Hold

Introduction

Create a new Mat Hold candlestick pattern to indicate the pattern's presence.

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

Using MatHold Indicator

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

    public override void Initialize()
    {
        _symbol = AddEquity("SPY", Resolution.Daily).Symbol;
        _mathold = CandlestickPatterns.MatHold(_symbol);
    }

    public override void OnData(Slice data)
    {
        if (_mathold.IsReady)
        {
            // The current value of _mathold is represented by itself (_mathold)
            // or _mathold.Current.Value
            Plot("MatHold", "mathold", _mathold);
            
        }
    }
}
class MatHoldAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.mathold = self.CandlestickPatterns.MatHold(self.symbol)

    def OnData(self, slice: Slice) -> None:
        if self.mathold.IsReady:
            # The current value of self.mathold is represented by self.mathold.Current.Value
            self.Plot("MatHold", "mathold", self.mathold.Current.Value)

The following reference table describes the MatHold method:

MatHold()1/1

            MatHold QuantConnect.Algorithm.CandlestickPatterns.MatHold (
    Symbol                            symbol,
    *Nullable<Resolution>       resolution,
    *Func<IBaseData, TradeBar>  selector
   )

Creates a new MatHold pattern indicator. The indicator will be automatically updated on the given resolution.

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 MatHold 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. The indicator will only be ready after you prime it with enough data.

public class MatHoldAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private MatHold _mathold;

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

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

        if (_mathold.IsReady)
        {
            // The current value of _mathold is represented by itself (_mathold)
            // or _mathold.Current.Value
            Plot("MatHold", "mathold", _mathold);
            
        }
    }
}
class MatHoldAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.mathold = MatHold()

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

        if self.mathold.IsReady:
            # The current value of self.mathold is represented by self.mathold.Current.Value
            self.Plot("MatHold", "mathold", self.mathold.Current.Value)

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

public class MatHoldAlgorithm : QCAlgorithm
{
    private Symbol _symbol;
    private MatHold _mathold;

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

    public override void OnData(Slice data)
    {
        if (_mathold.IsReady)
        {
            // The current value of _mathold is represented by itself (_mathold)
            // or _mathold.Current.Value
            Plot("MatHold", "mathold", _mathold);
            
        }
    }
}
class MatHoldAlgorithm(QCAlgorithm):
    def Initialize(self) -> None:
        self.symbol = self.AddEquity("SPY", Resolution.Daily).Symbol
        self.mathold = MatHold()
        self.RegisterIndicator(self.symbol, self.mathold, Resolution.Daily)

    def OnData(self, slice: Slice) -> None:
        if self.mathold.IsReady:
            # The current value of self.mathold is represented by self.mathold.Current.Value
            self.Plot("MatHold", "mathold", self.mathold.Current.Value)

The following reference table describes the MatHold constructor:

MatHold()1/3

            MatHold QuantConnect.Indicators.CandlestickPatterns.MatHold (
    string    name,
    *decimal  penetration
   )

Initializes a new instance of the MatHold class using the specified name.

MatHold()2/3

            MatHold QuantConnect.Indicators.CandlestickPatterns.MatHold (
    decimal  penetration
   )

Initializes a new instance of the MatHold class.

MatHold()3/3

            MatHold QuantConnect.Indicators.CandlestickPatterns.MatHold (
    
   )

Initializes a new instance of the MatHold class.

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: