Fix EKF measurement shape mismatch during manual step-by-step updates - #141
Open
leorouxx wants to merge 1 commit into
Open
Fix EKF measurement shape mismatch during manual step-by-step updates#141leorouxx wants to merge 1 commit into
leorouxx wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Summary
This pull request resolves issue #135, addressing a measurement shape mismatch that occurs during manual step-by-step updates in the Extended Kalman Filter (EKF) implementation when an EKF object is initialized empty, and magnetometer data is provided in the update function.
Changes Made
update() Method: Introduced a localuse_mag = mag is not Noneboolean flag to guarantee consistent evaluation of magnetometer presence throughout the update step, replacing redundant inline conditional checks.Expected Measurement Function (
h): Updated the function signature and header to accept the use_mag flag, ensuring the correct measurement vector shape is constructed.Linearized Measurement Matrix (
dhdq): Added the use_mag flag to the header to align with the revised measurement formulation.Documentation: Updated the docstrings for both h and dhdq to accurately document the new parameter usage and behavior.
Tests: Added a unit test in
TestEKFclass namedtest_step_by_step_with_mag. This test simulates the behavior pointed out in #135 and now passes.Explanation
I choose a solution with a boolean flag, that may be considered inelegant at first glance, but
handdhdqare stateless functions that are called only insideupdate.