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

Stick Sandwich candlestick pattern indicator More...

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

Public Member Functions

 StickSandwich (string name)
 Initializes a new instance of the StickSandwich class using the specified name. More...
 
 StickSandwich ()
 Initializes a new instance of the StickSandwich 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

Stick Sandwich candlestick pattern indicator

Must have:

  • first candle: black candle
  • second candle: white candle that trades only above the prior close(low > prior close)
  • third candle: black candle with the close equal to the first candle's close The meaning of "equal" is specified with SetCandleSettings The returned value is always positive(+1): stick sandwich is always bullish; The user should consider that stick sandwich is significant when coming in a downtrend, while this function does not consider it

Definition at line 33 of file StickSandwich.cs.

Constructor & Destructor Documentation

◆ StickSandwich() [1/2]

QuantConnect.Indicators.CandlestickPatterns.StickSandwich.StickSandwich ( string  name)

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

Parameters
nameThe name of this indicator

Definition at line 43 of file StickSandwich.cs.

Here is the call graph for this function:

◆ StickSandwich() [2/2]

QuantConnect.Indicators.CandlestickPatterns.StickSandwich.StickSandwich ( )

Initializes a new instance of the StickSandwich class.

Definition at line 52 of file StickSandwich.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.CandlestickPatterns.StickSandwich.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 71 of file StickSandwich.cs.

Here is the call graph for this function:

◆ Reset()

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

Resets this indicator to its initial state

Definition at line 113 of file StickSandwich.cs.

Property Documentation

◆ IsReady

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

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

Definition at line 61 of file StickSandwich.cs.


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