Explain the EKF localizer with equations and references

Offen
#97 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 9 Tagen

@bh-official arbeitet bereits daran.

Seit 26.10.2026.

  • #155 von @bh-official — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
python

Rechercherichtung

Read src/components/localization/kalman_filter/extended_kalman_filter_localizer.py alongside the predict and update steps. Match the implemented steps and Jacobians (F, G, H) to equations, then document the noise arguments and correct the typo. Use a standard textbook or original paper for the reference; done when beginners can match each step to its equation and all tests pass.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation good first issue

Problem

This repository is learning material, so the algorithm code should show the math it implements and where it comes from. In src/components/localization/kalman_filter/extended_kalman_filter_localizer.py:

  • The predict/update steps only have labels such as # predict state and # kalman gain. Write the equations they implement.
  • Explain where the Jacobians (F, G, H) come from.
  • The constructor docstring describes only color; document the noise arguments with units.
  • Input noise is generated by multiplying the variance matrix by randn. Either use the standard deviation or explain why.
  • Typo: "extimated".

Expected fix

  • Add the equations and a short explanation in docstrings/comments next to the code that implements them, keeping it easy to follow for beginners
  • Add a reference to the original paper or a standard textbook
  • Don't change the behavior unless the issue says so

Done when

A beginner can match each step of the code to an equation, and all tests pass.

Vorherrschende Sprache
Python
Sterne
1.9k
Forks
313
Ø Merge
9 T. 10 Std.
Gemergte PRs (30 T.)
7

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Enthält ein Dockerfile oder eine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ShisatoYano/AutonomousVehicleControlBeginnersGuide

Alle Issues in ShisatoYano/AutonomousVehicleControlBeginnersGuide

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.