Files
pandas-ta/pandas_ta/momentum/ao.py
T
2020-10-01 16:18:01 +01:00

71 lines
2.1 KiB
Python

# -*- coding: utf-8 -*-
from ..utils import get_offset, verify_series
def ao(high, low, fast=None, slow=None, offset=None, **kwargs):
"""Indicator: Awesome Oscillator (AO)"""
# Validate Arguments
high = verify_series(high)
low = verify_series(low)
fast = int(fast) if fast and fast > 0 else 5
slow = int(slow) if slow and slow > 0 else 34
if slow < fast:
fast, slow = slow, fast
min_periods = (int(kwargs["min_periods"]) if "min_periods" in kwargs and
kwargs["min_periods"] is not None else fast)
offset = get_offset(offset)
# Calculate Result
median_price = 0.5 * (high + low)
fast_sma = median_price.rolling(fast, min_periods=min_periods).mean()
slow_sma = median_price.rolling(slow, min_periods=min_periods).mean()
ao = fast_sma - slow_sma
# Offset
if offset != 0:
ao = ao.shift(offset)
# Handle fills
if "fillna" in kwargs:
ao.fillna(kwargs["fillna"], inplace=True)
if "fill_method" in kwargs:
ao.fillna(method=kwargs["fill_method"], inplace=True)
# Name and Categorize it
ao.name = f"AO_{fast}_{slow}"
ao.category = "momentum"
return ao
ao.__doc__ = """Awesome Oscillator (AO)
The Awesome Oscillator is an indicator used to measure a security's momentum.
AO is generally used to affirm trends or to anticipate possible reversals.
Sources:
https://www.tradingview.com/wiki/Awesome_Oscillator_(AO)
https://www.ifcm.co.uk/ntx-indicators/awesome-oscillator
Calculation:
Default Inputs:
fast=5, slow=34
SMA = Simple Moving Average
median = (high + low) / 2
AO = SMA(median, fast) - SMA(median, slow)
Args:
high (pd.Series): Series of 'high's
low (pd.Series): Series of 'low's
fast (int): The short period. Default: 5
slow (int): The long period. Default: 34
offset (int): How many periods to offset the result. Default: 0
Kwargs:
fillna (value, optional): pd.DataFrame.fillna(value)
fill_method (value, optional): Type of fill method
Returns:
pd.Series: New feature generated.
"""