Lean  $LEAN_TAG$
QuantConnect.Securities.Volatility.VolatilityModelExtensions Class Reference

Provides extension methods to volatility models More...

Static Public Member Functions

static void WarmUp (this IVolatilityModel volatilityModel, IHistoryProvider historyProvider, SubscriptionManager subscriptionManager, Security security, DateTime utcTime, DateTimeZone timeZone, bool liveMode, DataNormalizationMode? dataNormalizationMode=null)
 Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed. More...
 
static void WarmUp (this IndicatorVolatilityModel volatilityModel, IHistoryProvider historyProvider, SubscriptionManager subscriptionManager, Security security, DateTime utcTime, DateTimeZone timeZone, Resolution? resolution, int barCount, bool liveMode, DataNormalizationMode? dataNormalizationMode=null)
 Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed. More...
 
static void WarmUp (this IndicatorVolatilityModel volatilityModel, IAlgorithm algorithm, Security security, Resolution? resolution, int barCount, DataNormalizationMode? dataNormalizationMode=null)
 Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed. More...
 

Detailed Description

Provides extension methods to volatility models

Definition at line 30 of file VolatilityModelExtensions.cs.

Member Function Documentation

◆ WarmUp() [1/3]

static void QuantConnect.Securities.Volatility.VolatilityModelExtensions.WarmUp ( this IVolatilityModel  volatilityModel,
IHistoryProvider  historyProvider,
SubscriptionManager  subscriptionManager,
Security  security,
DateTime  utcTime,
DateTimeZone  timeZone,
bool  liveMode,
DataNormalizationMode dataNormalizationMode = null 
)
static

Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed.

Parameters
volatilityModelThe volatility model to be warmed up
historyProviderThe history provider to use to get historical data
subscriptionManagerThe subscription manager to use
securityThe security which volatility model is being warmed up
utcTimeThe current UTC time
timeZoneThe algorithm time zone
liveModeWhether the algorithm is in live mode
dataNormalizationModeThe security subscribed data normalization mode

Definition at line 44 of file VolatilityModelExtensions.cs.

Here is the call graph for this function:

◆ WarmUp() [2/3]

static void QuantConnect.Securities.Volatility.VolatilityModelExtensions.WarmUp ( this IndicatorVolatilityModel  volatilityModel,
IHistoryProvider  historyProvider,
SubscriptionManager  subscriptionManager,
Security  security,
DateTime  utcTime,
DateTimeZone  timeZone,
Resolution resolution,
int  barCount,
bool  liveMode,
DataNormalizationMode dataNormalizationMode = null 
)
static

Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed.

Parameters
volatilityModelThe volatility model to be warmed up
historyProviderThe history provider to use to get historical data
subscriptionManagerThe subscription manager to use
securityThe security which volatility model is being warmed up
utcTimeThe current UTC time
timeZoneThe algorithm time zone
resolutionThe data resolution required for the indicator
barCountThe bar count required to fully warm the indicator up
liveModeWhether the algorithm is in live mode
dataNormalizationModeThe security subscribed data normalization mode

Definition at line 78 of file VolatilityModelExtensions.cs.

Here is the call graph for this function:

◆ WarmUp() [3/3]

static void QuantConnect.Securities.Volatility.VolatilityModelExtensions.WarmUp ( this IndicatorVolatilityModel  volatilityModel,
IAlgorithm  algorithm,
Security  security,
Resolution resolution,
int  barCount,
DataNormalizationMode dataNormalizationMode = null 
)
static

Warms up the security's volatility model. This can happen either on initialization or after a split or dividend is processed.

Parameters
volatilityModelThe volatility model to be warmed up
algorithmThe algorithm running
securityThe security which volatility model is being warmed up
resolutionThe data resolution required for the indicator
barCountThe bar count required to fully warm the indicator up
dataNormalizationModeThe security subscribed data normalization mode

Definition at line 110 of file VolatilityModelExtensions.cs.


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