Module livekit.agents.utils.exp_filter

Classes

class ExpFilter (alpha: float, max_val: float = -1.0)

Expand source code

class ExpFilter:
    def __init__(self, alpha: float, max_val: float = -1.0) -> None:
        self._alpha = alpha
        self._filtered = -1.0
        self._max_val = max_val

    def reset(self, alpha: float = -1.0) -> None:
        if alpha != -1.0:
            self._alpha = alpha
        self._filtered = -1.0

    def apply(self, exp: float, sample: float) -> float:
        if self._filtered == -1.0:
            self._filtered = sample
        else:
            a = self._alpha**exp
            self._filtered = a * self._filtered + (1 - a) * sample

        if self._max_val != -1.0 and self._filtered > self._max_val:
            self._filtered = self._max_val

        return self._filtered

    def filtered(self) -> float:
        return self._filtered

    def update_base(self, alpha: float) -> None:
        self._alpha = alpha

Methods

def apply(self, exp: float, sample: float) ‑> float

Expand source code

def apply(self, exp: float, sample: float) -> float:
    if self._filtered == -1.0:
        self._filtered = sample
    else:
        a = self._alpha**exp
        self._filtered = a * self._filtered + (1 - a) * sample

    if self._max_val != -1.0 and self._filtered > self._max_val:
        self._filtered = self._max_val

    return self._filtered

def filtered(self) ‑> float

Expand source code

def filtered(self) -> float:
    return self._filtered

def reset(self, alpha: float = -1.0) ‑> None

Expand source code

def reset(self, alpha: float = -1.0) -> None:
    if alpha != -1.0:
        self._alpha = alpha
    self._filtered = -1.0

def update_base(self, alpha: float) ‑> None

Expand source code

def update_base(self, alpha: float) -> None:
    self._alpha = alpha