Lean  $LEAN_TAG$
QuantConnect.Indicators.AccelerationBands Class Reference

The Acceleration Bands created by Price Headley plots upper and lower envelope bands around a moving average. More...

Inheritance diagram for QuantConnect.Indicators.AccelerationBands:
[legend]

Public Member Functions

 AccelerationBands (string name, int period, decimal width, MovingAverageType movingAverageType=MovingAverageType.Simple)
 Initializes a new instance of the AccelerationBands class. More...
 
 AccelerationBands (int period, decimal width)
 Initializes a new instance of the AccelerationBands class. More...
 
 AccelerationBands (int period)
 Initializes a new instance of the AccelerationBands class. More...
 
override void Reset ()
 Resets this indicator to its initial state More...
 

Public Attributes

override bool IsReady => MiddleBand.IsReady && LowerBand.IsReady && UpperBand.IsReady
 Gets a flag indicating when this indicator is ready and fully initialized More...
 

Protected Member Functions

override decimal ComputeNextValue (IBaseDataBar input)
 Computes the next value of this indicator from the given state More...
 

Properties

MovingAverageType MovingAverageType [get]
 Gets the type of moving average More...
 
IndicatorBase< IndicatorDataPointMiddleBand [get]
 Gets the middle acceleration band (moving average) More...
 
IndicatorBase< IndicatorDataPointUpperBand [get]
 Gets the upper acceleration band (High * ( 1 + Width * (High - Low) / (High + Low))) More...
 
IndicatorBase< IndicatorDataPointLowerBand [get]
 Gets the lower acceleration band (Low * (1 - Width * (High - Low)/ (High + Low))) More...
 
int WarmUpPeriod [get]
 Required period, in data points, for the indicator to be ready and fully initialized. More...
 
- Properties inherited from QuantConnect.Indicators.IIndicatorWarmUpPeriodProvider
int WarmUpPeriod [get]
 Required period, in data points, for the indicator to be ready and fully initialized. More...
 

Detailed Description

The Acceleration Bands created by Price Headley plots upper and lower envelope bands around a moving average.

See also
Indicators.IndicatorBase<IBaseDataBar>

Definition at line 24 of file AccelerationBands.cs.

Constructor & Destructor Documentation

◆ AccelerationBands() [1/3]

QuantConnect.Indicators.AccelerationBands.AccelerationBands ( string  name,
int  period,
decimal  width,
MovingAverageType  movingAverageType = MovingAverageType.Simple 
)

Initializes a new instance of the AccelerationBands class.

Parameters
nameThe name of this indicator.
periodThe period of the three moving average (middle, upper and lower band).
widthA coefficient specifying the distance between the middle band and upper or lower bands.
movingAverageTypeType of the moving average.

Definition at line 55 of file AccelerationBands.cs.

◆ AccelerationBands() [2/3]

QuantConnect.Indicators.AccelerationBands.AccelerationBands ( int  period,
decimal  width 
)

Initializes a new instance of the AccelerationBands class.

Parameters
periodThe period of the three moving average (middle, upper and lower band).
widthA coefficient specifying the distance between the middle band and upper or lower bands.

Definition at line 72 of file AccelerationBands.cs.

◆ AccelerationBands() [3/3]

QuantConnect.Indicators.AccelerationBands.AccelerationBands ( int  period)

Initializes a new instance of the AccelerationBands class.

Parameters
periodThe period of the three moving average (middle, upper and lower band).

Definition at line 81 of file AccelerationBands.cs.

Member Function Documentation

◆ Reset()

override void QuantConnect.Indicators.AccelerationBands.Reset ( )

Resets this indicator to its initial state

Definition at line 99 of file AccelerationBands.cs.

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.AccelerationBands.ComputeNextValue ( IBaseDataBar  input)
protected

Computes the next value of this indicator from the given state

Parameters
inputThe input given to the indicator
Returns
A new value for this indicator

Definition at line 114 of file AccelerationBands.cs.

Member Data Documentation

◆ IsReady

override bool QuantConnect.Indicators.AccelerationBands.IsReady => MiddleBand.IsReady && LowerBand.IsReady && UpperBand.IsReady

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

Definition at line 89 of file AccelerationBands.cs.

Property Documentation

◆ MovingAverageType

MovingAverageType QuantConnect.Indicators.AccelerationBands.MovingAverageType
get

Gets the type of moving average

Definition at line 31 of file AccelerationBands.cs.

◆ MiddleBand

IndicatorBase<IndicatorDataPoint> QuantConnect.Indicators.AccelerationBands.MiddleBand
get

Gets the middle acceleration band (moving average)

Definition at line 36 of file AccelerationBands.cs.

◆ UpperBand

IndicatorBase<IndicatorDataPoint> QuantConnect.Indicators.AccelerationBands.UpperBand
get

Gets the upper acceleration band (High * ( 1 + Width * (High - Low) / (High + Low)))

Definition at line 41 of file AccelerationBands.cs.

◆ LowerBand

IndicatorBase<IndicatorDataPoint> QuantConnect.Indicators.AccelerationBands.LowerBand
get

Gets the lower acceleration band (Low * (1 - Width * (High - Low)/ (High + Low)))

Definition at line 46 of file AccelerationBands.cs.

◆ WarmUpPeriod

int QuantConnect.Indicators.AccelerationBands.WarmUpPeriod
get

Required period, in data points, for the indicator to be ready and fully initialized.

Definition at line 94 of file AccelerationBands.cs.


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