Lean  $LEAN_TAG$
QuantConnect.Indicators.CandlestickPatterns.MatHold Class Reference

Mat Hold candlestick pattern More...

Inheritance diagram for QuantConnect.Indicators.CandlestickPatterns.MatHold:
[legend]

Public Member Functions

 MatHold (string name, decimal penetration=0.5m)
 Initializes a new instance of the MatHold class using the specified name. More...
 
 MatHold (decimal penetration)
 Initializes a new instance of the MatHold class. More...
 
 MatHold ()
 Initializes a new instance of the MatHold class. More...
 
override void Reset ()
 Resets this indicator to its initial state More...
 
- Public Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IBaseDataBar >
override void Reset ()
 Resets this indicator to its initial state More...
 

Protected Member Functions

override decimal ComputeNextValue (IReadOnlyWindow< IBaseDataBar > window, IBaseDataBar input)
 Computes the next value of this indicator from the given state More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.CandlestickPatterns.CandlestickPattern
 CandlestickPattern (string name, int period)
 Creates a new CandlestickPattern with the specified name More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IBaseDataBar >
 WindowIndicator (string name, int period)
 Initializes a new instance of the WindowIndicator class More...
 
override decimal ComputeNextValue (T input)
 Computes the next value of this indicator from the given state More...
 
abstract decimal ComputeNextValue (IReadOnlyWindow< T > window, T input)
 Computes the next value for this indicator from the given state. More...
 

Properties

override bool IsReady [get]
 Gets a flag indicating when this indicator is ready and fully initialized More...
 

Additional Inherited Members

- Public Attributes inherited from QuantConnect.Indicators.WindowIndicator< IBaseDataBar >
int Period
 Gets the period of this window indicator More...
 
override bool IsReady
 Gets a flag indicating when this indicator is ready and fully initialized More...
 
virtual int WarmUpPeriod
 Required period, in data points, to the indicator to be ready and fully initialized More...
 
- Static Protected Member Functions inherited from QuantConnect.Indicators.CandlestickPatterns.CandlestickPattern
static CandleColor GetCandleColor (IBaseDataBar tradeBar)
 Returns the candle color of a candle More...
 
static decimal GetRealBody (IBaseDataBar tradeBar)
 Returns the distance between the close and the open of a candle More...
 
static decimal GetHighLowRange (IBaseDataBar tradeBar)
 Returns the full range of the candle More...
 
static decimal GetCandleRange (CandleSettingType type, IBaseDataBar tradeBar)
 Returns the range of a candle More...
 
static bool GetCandleGapUp (IBaseDataBar tradeBar, IBaseDataBar previousBar)
 Returns true if the candle is higher than the previous one More...
 
static bool GetCandleGapDown (IBaseDataBar tradeBar, IBaseDataBar previousBar)
 Returns true if the candle is lower than the previous one More...
 
static bool GetRealBodyGapUp (IBaseDataBar tradeBar, IBaseDataBar previousBar)
 Returns true if the candle is higher than the previous one (with no body overlap) More...
 
static bool GetRealBodyGapDown (IBaseDataBar tradeBar, IBaseDataBar previousBar)
 Returns true if the candle is lower than the previous one (with no body overlap) More...
 
static decimal GetLowerShadow (IBaseDataBar tradeBar)
 Returns the range of the candle's lower shadow More...
 
static decimal GetUpperShadow (IBaseDataBar tradeBar)
 Returns the range of the candle's upper shadow More...
 
static decimal GetCandleAverage (CandleSettingType type, decimal sum, IBaseDataBar tradeBar)
 Returns the average range of the previous candles More...
 

Detailed Description

Mat Hold candlestick pattern

Must have:

  • first candle: long white candle
  • upside gap between the first and the second bodies
  • second candle: small black candle
  • third and fourth candles: falling small real body candlesticks(commonly black) that hold within the long white candle's body and are higher than the reaction days of the rising three methods
  • fifth candle: white candle that opens above the previous small candle's close and closes higher than the high of the highest reaction day The meaning of "short" and "long" is specified with SetCandleSettings; "hold within" means "a part of the real body must be within"; penetration is the maximum percentage of the first white body the reaction days can penetrate(it is to specify how much the reaction days should be "higher than the reaction days of the rising three methods") The returned value is positive(+1): mat hold is always bullish

Definition at line 40 of file MatHold.cs.

Constructor & Destructor Documentation

◆ MatHold() [1/3]

QuantConnect.Indicators.CandlestickPatterns.MatHold.MatHold ( string  name,
decimal  penetration = 0.5m 
)

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

Parameters
nameThe name of this indicator
penetrationPercentage of penetration of a candle within another candle

Definition at line 54 of file MatHold.cs.

Here is the call graph for this function:

◆ MatHold() [2/3]

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

Initializes a new instance of the MatHold class.

Parameters
penetrationPercentage of penetration of a candle within another candle

Definition at line 67 of file MatHold.cs.

◆ MatHold() [3/3]

QuantConnect.Indicators.CandlestickPatterns.MatHold.MatHold ( )

Initializes a new instance of the MatHold class.

Definition at line 75 of file MatHold.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.CandlestickPatterns.MatHold.ComputeNextValue ( IReadOnlyWindow< IBaseDataBar window,
IBaseDataBar  input 
)
protected

Computes the next value of this indicator from the given state

Parameters
windowThe window of data held in this indicator
inputThe input given to the indicator
Returns
A new value for this indicator

Definition at line 94 of file MatHold.cs.

Here is the call graph for this function:

◆ Reset()

override void QuantConnect.Indicators.CandlestickPatterns.MatHold.Reset ( )

Resets this indicator to its initial state

Definition at line 162 of file MatHold.cs.

Property Documentation

◆ IsReady

override bool QuantConnect.Indicators.CandlestickPatterns.MatHold.IsReady
get

Gets a flag indicating when this indicator is ready and fully initialized

Definition at line 84 of file MatHold.cs.


The documentation for this class was generated from the following file: