From 739ce92f66b0b8ca1728260895f5f90ab58ebf76 Mon Sep 17 00:00:00 2001
From: Anton Kullberg <anton.kullberg@liu.se>
Date: Fri, 12 Nov 2021 16:52:43 +0100
Subject: [PATCH] doc: updated IMM filter documentation

---
 src/filters.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/filters.py b/src/filters.py
index bcd2c09..77b75ec 100644
--- a/src/filters.py
+++ b/src/filters.py
@@ -77,6 +77,9 @@ class IMM:
     def __init__(self, filters, sensor_model, transition_prob):
         """An implementation of an Interacting Multiple Model filter.
 
+        NOTE: Not a good implementation in the sense that it needs a specialized
+        tracker implementation to actually be useable, see src.trackers.IMMTracker.
+
         Parameters
         ----------
         filters : list
-- 
GitLab