Skip to content

BaseIndicator


class backtide.indicators.base.BaseIndicator()[source]

Abstract base class for all indicators.

Subclass it to create a custom indicator.


Example

from backtide.indicators import BaseIndicator

class MyMomentum(BaseIndicator):
    def __init__(self, period = 10):
        self.period = period

    def compute(self, data):
        return data["close"].diff(self.period)


Methods

compute Compute the indicator values.


method backtide.indicators.basecompute(data)[source]

Compute the indicator values.

Parameters

data : np.array | pd.DataFrame | pl.DataFrame

Historical OHLCV data. The type depends on the dataframe_library configuration.

Returns

np.ndarray | pd.Series | pd.DataFrame | pl.Series | pl.DataFrame

Single series for one-output indicators, or 2d for multi-output indicators (e.g., Bollinger Bands).