QuantConnect.Indicators.Vortex Class Reference

Represents the Vortex Indicator, which identifies the start and continuation of market trends. It includes components that capture positive (upward) and negative (downward) trend movements. This indicator compares the ranges within the current period to previous periods to calculate upward and downward movement trends. More...

Inheritance diagram for QuantConnect.Indicators.Vortex:

Public Member Functions
	Vortex (int period)
	Initializes a new instance of the Vortex class using the specified period. More...
	Vortex (string name, int period)
	Initializes a new instance of the Vortex class with a custom name and period. More...
override void	Reset ()
	Resets all indicators and internal state. More...

Public Attributes
override bool	IsReady => Samples >= _period
	Indicates whether this indicator is fully ready and all buffers have been filled. More...
int	WarmUpPeriod => _period
	The minimum number of samples needed for the indicator to be ready and provide reliable values. More...

Protected Member Functions
override decimal	ComputeNextValue (IBaseDataBar input)
	Computes the next value of the Vortex Indicator based on the provided input. More...
Protected Member Functions inherited from QuantConnect.Indicators.BarIndicator
	BarIndicator (string name)
	Creates a new TradeBarIndicator with the specified name More...

Properties
IndicatorBase< IndicatorDataPoint >	PlusVortex [get]
	Gets the Positive Vortex Indicator, which reflects positive trend movements. More...
IndicatorBase< IndicatorDataPoint >	MinusVortex [get]
	Gets the Negative Vortex Indicator, which reflects negative trend movements. 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

Represents the Vortex Indicator, which identifies the start and continuation of market trends. It includes components that capture positive (upward) and negative (downward) trend movements. This indicator compares the ranges within the current period to previous periods to calculate upward and downward movement trends.

Definition at line 27 of file Vortex.cs.

Constructor & Destructor Documentation

Vortex() [1/2]

QuantConnect.Indicators.Vortex.Vortex

(

int

period

)

Initializes a new instance of the Vortex class using the specified period.

Parameters

period

The number of periods used to construct the Vortex Indicator.

Definition at line 60 of file Vortex.cs.

Vortex() [2/2]

QuantConnect.Indicators.Vortex.Vortex	(	string	name,
		int	period
	)

Initializes a new instance of the Vortex class with a custom name and period.

Parameters

name	The custom name for this instance of the Vortex Indicator.
period	The number of periods used to construct the Vortex Indicator.

Definition at line 70 of file Vortex.cs.

Member Function Documentation

ComputeNextValue()

override decimal QuantConnect.Indicators.Vortex.ComputeNextValue ( IBaseDataBar  input )

protected

Computes the next value of the Vortex Indicator based on the provided input.

Parameters

input

The input data used to compute the indicator value.

Returns

The computed value of the indicator.

Definition at line 88 of file Vortex.cs.

Reset()

override void QuantConnect.Indicators.Vortex.Reset

(

)

Resets all indicators and internal state.

Definition at line 114 of file Vortex.cs.

Member Data Documentation

IsReady

override bool QuantConnect.Indicators.Vortex.IsReady => Samples >= _period

Indicates whether this indicator is fully ready and all buffers have been filled.

Definition at line 49 of file Vortex.cs.

WarmUpPeriod

int QuantConnect.Indicators.Vortex.WarmUpPeriod => _period

The minimum number of samples needed for the indicator to be ready and provide reliable values.

Definition at line 54 of file Vortex.cs.

Property Documentation

PlusVortex

IndicatorBase<IndicatorDataPoint> QuantConnect.Indicators.Vortex.PlusVortex

get

Gets the Positive Vortex Indicator, which reflects positive trend movements.

Definition at line 39 of file Vortex.cs.

MinusVortex

IndicatorBase<IndicatorDataPoint> QuantConnect.Indicators.Vortex.MinusVortex

get

Gets the Negative Vortex Indicator, which reflects negative trend movements.

Definition at line 44 of file Vortex.cs.

---

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

• Indicators/Vortex.cs