Mode of finite observations (ta.mode)

View Markdown

Return the mode of the most recent length finite observations; ties choose the smallest, non-finite values are skipped, and missing rows retain the result after the window fills.

Indicator catalog · How to use indicators

Run this example

This complete script uses bundled data. It observes the selected output without placing trades.

import numpy as np
from openbacktesting import Backtest, Strategy
from openbacktesting.test import GOOG

data = GOOG.copy()

class Example(Strategy):
    def init(self):
        self.value = self.ta.mode(self.close)
        self.latest_value = None

    def next(self):
        channel = self.value
        if channel.valid[-1]:
            self.latest_value = float(channel[-1])

result = Backtest(data, Example).run()
print(result["_strategy"].latest_value)

Call and parameters

self.ta.mode(source=None, *, length=5, inputs=None, backend=None, required_outputs=None)

Register in init(). Read the returned channel in next() after checking valid[-1].

Parameter	Meaning	Type	Default	Allowed values
length	Number of most recent finite observations, rather than consecutive bars.	int	5	Minimum: 1

source/named source arguments accept a column name or same-run single-channel handle. Alternatively, inputs maps each input below to a column or handle. backend selects a supported implementation; required_outputs selects channels for readiness diagnostics. See shared arguments and handles.

Inputs and outputs

Required inputs: close.

Channel	Meaning
mode	Mode of finite observations value

Reading values safely

Insufficient history or missing inputs can make a channel invalid. Check that channel's valid mask; ready is diagnostic and never suppresses next(). Multi-output results may have different valid channels on the same bar.

The window counts finite observations; missing rows do not consume it. Ties choose the smallest value.

Indicator catalog · Custom calculations