Lean  $LEAN_TAG$
QuantConnect.Securities.RelativeStandardDeviationVolatilityModel Class Reference

Provides an implementation of IVolatilityModel that computes the relative standard deviation as the volatility of the security More...

Inheritance diagram for QuantConnect.Securities.RelativeStandardDeviationVolatilityModel:
[legend]

Public Member Functions

 RelativeStandardDeviationVolatilityModel (TimeSpan periodSpan, int periods)
 Initializes a new instance of the RelativeStandardDeviationVolatilityModel class More...
 
override void Update (Security security, BaseData data)
 Updates this model using the new price information in the specified security instance More...
 
override IEnumerable< HistoryRequestGetHistoryRequirements (Security security, DateTime utcTime)
 Returns history requirements for the volatility model expressed in the form of history request More...
 
- Public Member Functions inherited from QuantConnect.Securities.Volatility.BaseVolatilityModel
virtual void SetSubscriptionDataConfigProvider (ISubscriptionDataConfigProvider subscriptionDataConfigProvider)
 Sets the ISubscriptionDataConfigProvider instance to use. More...
 
IEnumerable< HistoryRequestGetHistoryRequirements (Security security, DateTime utcTime, Resolution? resolution, int barCount)
 Gets history requests required for warming up the greeks with the provided resolution More...
 

Properties

override decimal Volatility [get]
 Gets the volatility of the security as a percentage More...
 
- Properties inherited from QuantConnect.Securities.Volatility.BaseVolatilityModel
ISubscriptionDataConfigProvider SubscriptionDataConfigProvider [get, set]
 Provides access to registered SubscriptionDataConfig More...
 
virtual decimal Volatility [get]
 Gets the volatility of the security as a percentage More...
 
- Properties inherited from QuantConnect.Securities.IVolatilityModel
decimal Volatility [get]
 Gets the volatility of the security as a percentage More...
 

Detailed Description

Provides an implementation of IVolatilityModel that computes the relative standard deviation as the volatility of the security

Definition at line 32 of file RelativeStandardDeviationVolatilityModel.cs.

Constructor & Destructor Documentation

◆ RelativeStandardDeviationVolatilityModel()

QuantConnect.Securities.RelativeStandardDeviationVolatilityModel.RelativeStandardDeviationVolatilityModel ( TimeSpan  periodSpan,
int  periods 
)

Initializes a new instance of the RelativeStandardDeviationVolatilityModel class

Parameters
periodSpanThe time span representing one 'period' length
periodsThe number of 'period' lengths to wait until updating the value

Definition at line 76 of file RelativeStandardDeviationVolatilityModel.cs.

Member Function Documentation

◆ Update()

override void QuantConnect.Securities.RelativeStandardDeviationVolatilityModel.Update ( Security  security,
BaseData  data 
)
virtual

Updates this model using the new price information in the specified security instance

Parameters
securityThe security to calculate volatility for
data

Reimplemented from QuantConnect.Securities.Volatility.BaseVolatilityModel.

Definition at line 92 of file RelativeStandardDeviationVolatilityModel.cs.

◆ GetHistoryRequirements()

override IEnumerable<HistoryRequest> QuantConnect.Securities.RelativeStandardDeviationVolatilityModel.GetHistoryRequirements ( Security  security,
DateTime  utcTime 
)
virtual

Returns history requirements for the volatility model expressed in the form of history request

Parameters
securityThe security of the request
utcTimeThe date/time of the request
Returns
History request object list, or empty if no requirements

Reimplemented from QuantConnect.Securities.Volatility.BaseVolatilityModel.

Definition at line 112 of file RelativeStandardDeviationVolatilityModel.cs.

Property Documentation

◆ Volatility

override decimal QuantConnect.Securities.RelativeStandardDeviationVolatilityModel.Volatility
get

Gets the volatility of the security as a percentage

Definition at line 45 of file RelativeStandardDeviationVolatilityModel.cs.


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