xsignals#
API documentation for pandas_ta.trend.xsignals Python function.
- xsignals(signal, xa, xb, above=True, long=True, asbool=None, trend_reset=0, trade_offset=None, offset=None, **kwargs)[source]#
Cross Signals (XSIGNALS)
Cross Signals returns Trend Signal (TSIGNALS) results for Signal Crossings. This is useful for indicators like RSI, ZSCORE, et al where one wants trade Entries and Exits (and Trends).
Cross Signals has two kinds of modes: above and long.
The first mode ‘above’, default True, xsignals determines if the signal first crosses above ‘xa’ and then below ‘xb’. If ‘above’ is False, xsignals determines if the signal first crosses below ‘xa’ and then above ‘xb’.
The second mode ‘long’, default True, passes the long trend result into tsignals so it can determine the appropriate Entries and Exits. When ‘long’ is False, it does the same but for the short side.
Example: # These are two different outcomes and depends on the indicator and it’s # characteristics. Please check BOTH outcomes BEFORE making an Issue. rsi = df.ta.rsi() # Returns tsignal DataFrame when RSI crosses above 20 and then below 80 ta.xsignals(rsi, 20, 80, above=True) # Returns tsignal DataFrame when RSI crosses below 20 and then above 80 ta.xsignals(rsi, 20, 80, above=False)
Source: Kevin Johnson
- Calculation:
- Default Inputs:
asbool=False, trend_reset=0, trade_offset=0, drift=1
trades = trends.diff().shift(trade_offset).fillna(0).astype(int) entries = (trades > 0).astype(int) exits = (trades < 0).abs().astype(int)
- Args:
- above (bool): When the signal crosses above ‘xa’ first and then ‘xb’. When
False, then when the signal crosses below ‘xa’ first and then ‘xb’. Default: True
- long (bool): Passes the long trend into tsignals’ trend argument. When
False, it passes the short trend into tsignals trend argument. Default: True
drift (int): The difference period. Default: 1 offset (int): How many periods to offset the result. Default: 0
# TSIGNAL Passthrough arguments asbool (bool): If True, it converts the Trends, Entries and Exits columns to
booleans. When boolean, it is also useful for backtesting with vectorbt’s Portfolio.from_signal(close, entries, exits) Default: False
trend_reset (value): Value used to identify if a trend has ended. Default: 0 trade_offset (value): Value used shift the trade entries/exits Use 1 for
backtesting and 0 for live. Default: 0
- Kwargs:
fillna (value, optional): pd.DataFrame.fillna(value) fill_method (value, optional): Type of fill method
- Returns:
pd.DataFrame with columns: Trends (trend: 1, no trend: 0), Trades (Enter: 1, Exit: -1, Otherwise: 0), Entries (entry: 1, nothing: 0), Exits (exit: 1, nothing: 0)