EmaCrossAlphaModel

QuantConnect.Algorithm.Framework.Alphas.EmaCrossAlphaModel

EmaCrossAlphaModel(
    fast_period: int = 12,
    slow_period: int = 26,
    resolution: Resolution = ...,
)

Bases: AlphaModel

Alpha model that uses an EMA cross to create insights

Initializes a new instance of the EmaCrossAlphaModel class

Parameters:

Name	Type	Description	Default
fast_period	int	The fast EMA period	12
slow_period	int	The slow EMA period	26
resolution	Resolution	The resolution of data sent into the EMA indicators	...

symbol_data_by_symbol

symbol_data_by_symbol: Dictionary[Symbol, SymbolData]

This is made protected for testing purposes

This codeEntityType is protected.

name

name: str

Defines a name for a framework model

instance

instance: Any

Gets the underlying python instance

This codeEntityType is protected.

SymbolData

SymbolData(
    security: Security,
    fast_period: int,
    slow_period: int,
    algorithm: QCAlgorithm,
    resolution: Resolution,
)

Bases: Object

Contains data specific to a symbol required by this model

Initializes an instance of the class SymbolData with the given arguments

symbol

symbol: Symbol

Symbol associated with the data

fast

fast: ExponentialMovingAverage

Fast Exponential Moving Average (EMA)

slow

slow: ExponentialMovingAverage

Slow Exponential Moving Average (EMA)

fast_is_over_slow

fast_is_over_slow: bool

True if the fast is above the slow, otherwise false. This is used to prevent emitting the same signal repeatedly

slow_is_over_fast

slow_is_over_fast: bool

Flag indicating if the Slow EMA is over the Fast one

remove_consolidators

remove_consolidators() -> None

Remove Fast and Slow consolidators

PythonRuntimeChecker

Bases: Object

Set of helper methods to invoke Python methods with runtime checks for return values and out parameter's conversions.

on_securities_changed

on_securities_changed(
    algorithm: QCAlgorithm, changes: SecurityChanges
) -> None

Event fired each time the we add/remove securities from the data feed

Parameters:

Name	Type	Description	Default
algorithm	QCAlgorithm	The algorithm instance that experienced the change in securities	required
changes	SecurityChanges	The security additions and removals from the algorithm	required

update

update(
    algorithm: QCAlgorithm, data: Slice
) -> Iterable[Insight]

Updates this alpha model with the latest data from the algorithm. This is called each time the algorithm receives data for subscribed securities

Parameters:

Name	Type	Description	Default
algorithm	QCAlgorithm	The algorithm instance	required
data	Slice	The new data available	required

Returns:

Type	Description
Iterable[Insight]	The new insights generated.

equals

equals(obj: Any) -> bool

equals(
    other: BasePythonWrapper[
        QuantConnect_Python_BasePythonWrapper_TInterface
    ],
) -> bool

Signature descriptions:

• Determines whether the specified object is an instance of BasePythonWrapper{TInterface} and wraps the same Python object reference as this instance, which would indicate that they are equal.

• Determines whether the specified instance wraps the same Python object reference as this instance, which would indicate that they are equal.

Parameters:

Name	Type	Description	Default
obj	Optional[Any]	The other object to compare this with	None
other	Optional[BasePythonWrapper[QuantConnect_Python_BasePythonWrapper_TInterface]]	The other object to compare this with	None

Returns:

Type	Description
bool	True if both instances are equal, that is if both wrap the same Python object reference.

set_python_instance

set_python_instance(instance: Any) -> None

set_python_instance(
    instance: Any, validate_interface: bool
) -> None

Signature descriptions:

• Sets the python instance

• Sets the python instance and sets the validate interface flag

Parameters:

Name	Type	Description	Default
instance	Any	The underlying python instance	required
validate_interface	Optional[bool]	Whether to perform validations for interface implementation	None

dispose

dispose() -> None

Dispose of this instance

get_event

get_event(name: str) -> Any

Gets the Python instance event with the specified name

Parameters:

Name	Type	Description	Default
name	str	The name of the event	required

get_hash_code

get_hash_code() -> int

Gets the hash code for the current instance

Returns:

Type	Description
int	The hash code of the current instance.

get_method

get_method(
    method_name: str, python_only: bool = False
) -> Any

Gets the Python instances method with the specified name and caches it

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
python_only	bool	Whether to only return python methods	False

Returns:

Type	Description
Any	The matched method.

get_property

get_property(property_name: str) -> Any

Gets the Python instance property with the specified name

Parameters:

Name	Type	Description	Default
property_name	str	The name of the property	required

has_attr

has_attr(name: str) -> bool

Determines whether the Python instance has the specified attribute

Parameters:

Name	Type	Description	Default
name	str	The attribute name	required

Returns:

Type	Description
bool	Whether the Python instance has the specified attribute.

invoke_method

invoke_method(
    method_name: str, *args: Union[Object, Iterable[Object]]
) -> Any

Invokes the specified method with the specified arguments

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
args	Union[Object, Iterable[Object]]	The arguments to call the method with	()

invoke_void_method

invoke_void_method(
    method_name: str, *args: Union[Object, Iterable[Object]]
) -> None

Invokes the specified method with the specified arguments without returning a value

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
args	Union[Object, Iterable[Object]]	The arguments to call the method with	()

set_property

set_property(property_name: str, value: Any) -> None

Sets the Python instance property with the specified name

Parameters:

Name	Type	Description	Default
property_name	str	The name of the property	required
value	Any	The property value	required