Lean  $LEAN_TAG$
QuantConnect.Indicators.StandardDeviation Class Reference

This indicator computes the n-period population standard deviation. More...

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

Public Member Functions

 StandardDeviation (int period)
 Initializes a new instance of the StandardDeviation class with the specified period. More...
 
 StandardDeviation (string name, int period)
 Initializes a new instance of the StandardDeviation class with the specified name and period. More...
 
- Public Member Functions inherited from QuantConnect.Indicators.Variance
 Variance (int period)
 Initializes a new instance of the Variance class using the specified period. More...
 
 Variance (string name, int period)
 Initializes a new instance of the Variance class using the specified name and period. More...
 
override void Reset ()
 Resets this indicator to its initial state More...
 
- Public Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
override void Reset ()
 Resets this indicator to its initial state More...
 

Protected Member Functions

override decimal ComputeNextValue (IReadOnlyWindow< IndicatorDataPoint > window, IndicatorDataPoint input)
 Computes the next value of this indicator from the given state More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.Variance
override decimal ComputeNextValue (IReadOnlyWindow< IndicatorDataPoint > window, IndicatorDataPoint input)
 Computes the next value of this indicator from the given state More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
 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...
 

Additional Inherited Members

- Public Attributes inherited from QuantConnect.Indicators.Variance
int WarmUpPeriod => Period
 Required period, in data points, for the indicator to be ready and fully initialized. More...
 
- Public Attributes inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
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...
 
- 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

This indicator computes the n-period population standard deviation.

Definition at line 23 of file StandardDeviation.cs.

Constructor & Destructor Documentation

◆ StandardDeviation() [1/2]

QuantConnect.Indicators.StandardDeviation.StandardDeviation ( int  period)

Initializes a new instance of the StandardDeviation class with the specified period.

Evaluates the standard deviation of samples in the look-back period. On a data set of size N will use an N normalizer and would thus be biased if applied to a subset.

Parameters
periodThe sample size of the standard deviation

Definition at line 32 of file StandardDeviation.cs.

◆ StandardDeviation() [2/2]

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

Initializes a new instance of the StandardDeviation class with the specified name and period.

Evaluates the standard deviation of samples in the look-back period. On a data set of size N will use an N normalizer and would thus be biased if applied to a subset.

Parameters
nameThe name of this indicator
periodThe sample size of the standard deviation

Definition at line 45 of file StandardDeviation.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.StandardDeviation.ComputeNextValue ( IReadOnlyWindow< IndicatorDataPoint window,
IndicatorDataPoint  input 
)
protected

Computes the next value of this indicator from the given state

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

Definition at line 56 of file StandardDeviation.cs.


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