Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples: State estimation - Kalman filter #126

Merged
merged 8 commits into from
Dec 13, 2023
Merged

Conversation

kjjarvis
Copy link
Contributor

@kjjarvis kjjarvis commented Dec 4, 2023

Starting the state estimation notebook with a Kalman filter example

@kjjarvis kjjarvis requested a review from teubert December 4, 2023 21:41
Copy link

github-actions bot commented Dec 4, 2023

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

  • Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
  • Ensure that each PR adding a new feature should include a test verifying that feature.
  • All errors from static analysis must be resolved.
  • Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
  • Review the software benchmarking results (if there is a change) - will be added as comment on PR
  • Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
  • All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

@codecov-commenter
Copy link

codecov-commenter commented Dec 4, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0980f8c) 83.41% compared to head (f6085a0) 83.41%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #126   +/-   ##
=======================================
  Coverage   83.41%   83.41%           
=======================================
  Files         100      100           
  Lines       10462    10462           
=======================================
  Hits         8727     8727           
  Misses       1735     1735           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@teubert teubert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great intro to Kalman Filter. A few cosmetic recommendations

examples/07_State_Estimation.ipynb Outdated Show resolved Hide resolved
examples/07_State_Estimation.ipynb Outdated Show resolved Hide resolved
examples/07_State_Estimation.ipynb Outdated Show resolved Hide resolved
examples/07_State_Estimation.ipynb Outdated Show resolved Hide resolved
" x = m.next_state(x, u, dt)"
]
},
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about plotting the error in each state variable over time? A visual representation might help the user understand its function.

examples/07_State_Estimation.ipynb Show resolved Hide resolved
@teubert teubert merged commit 8125b16 into dev Dec 13, 2023
29 of 30 checks passed
@teubert teubert deleted the examples/kalman_filter branch December 21, 2023 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants