contango.stream.indicators.state.wilder_average_state

contango.stream.indicators.state.wilder_average_state

WilderState

Bases: Enum

Current location of the fast wilder average relative to the slow wilder average for a bar.

Attributes:

Name	Type	Description
BELOW		The fast wilder average is below the slow wilder average.
ABOVE		The fast wilder average is above the slow wilder average.

get_state classmethod

get_state(fast_wilder_average: float, slow_wilder_average: float) -> WilderState

Returns the state of the fast wilder average relative to the slow wilder average (above or below).

Parameters:

Name	Type	Description	Default
fast_wilder_average	float	The fast wilder average value for the current bar.	required
slow_wilder_average	float	The slow wilder average value for the current bar.	required

Returns:

Name	Type	Description
WilderState	WilderState	Whether the fast wilder average is below or above the slow wilder average.

Source code in src\contango\stream\indicators\state\wilder_average_state.py

@classmethod
def get_state(cls, fast_wilder_average: float, slow_wilder_average: float) -> WilderState:
    """
    Returns the state of the fast wilder average relative to the slow wilder average (above or below).

    Args:
        fast_wilder_average: The fast wilder average value for the current bar.
        slow_wilder_average: The slow wilder average value for the current bar.

    Returns:
        WilderState: Whether the fast wilder average is below or above the slow wilder average.
    """
    if fast_wilder_average > slow_wilder_average:
        return WilderState.ABOVE
    else:
        return WilderState.BELOW