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

Feature/gauss markov refactor #862

Merged
merged 5 commits into from
Dec 6, 2024
Merged

Conversation

Natsoulas
Copy link
Contributor

  • Tickets addressed: bsk-800
  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

The GaussMarkov class is rewritten in this PR to provide readable syntax, random walk bounds enforcement, and a resolution to the previously required 1.5x multiplier on process noise standard deviation. All downstream instantiations of the GaussMarkov class in sensors are updated accordingly. More precisely, the 1.5x multiplier is removed and bounds are actually implemented. Finally, this PR introduces a new scenario that serves as both an example of the functionality of GaussMarkov for noise modeling as well as a proof of such functionality.

Verification

Relevant automated unit tests were edited to not use a 1.5x multiplier and to have relaxed tolerances such that bounded-random walk functionality is actually tested. The new scenario introduced also has its own automated unit test that generates an image showcasing GaussMarkov behavior.

Documentation

The documentation prescribing the 1.5x multiplier for the GaussMarkov noise std is invalidated by this pr. The reviewer should ensure the assignee edited any documentation of the 1.5x multiplier such that this prescription is removed as it is deprecated in this pr.

Future work

Resolve any concerns or raised issues of developers using the newly updated Gauss Markov class.

@Natsoulas Natsoulas added documentation Improvements or additions to documentation enhancement New feature or request refactor Clean up with no new functionality labels Nov 27, 2024
@Natsoulas Natsoulas self-assigned this Nov 27, 2024
@Natsoulas Natsoulas requested a review from a team as a code owner November 27, 2024 07:31
@Natsoulas Natsoulas force-pushed the feature/gauss-markov-refactor branch 6 times, most recently from 6ad08e6 to 537d86d Compare November 27, 2024 17:43
@Natsoulas Natsoulas force-pushed the feature/gauss-markov-refactor branch from 537d86d to eee4f7a Compare December 4, 2024 23:51
@Natsoulas Natsoulas force-pushed the feature/gauss-markov-refactor branch from eee4f7a to 551cb71 Compare December 4, 2024 23:52
@schaubh schaubh linked an issue Dec 5, 2024 that may be closed by this pull request
Copy link
Contributor

@schaubh schaubh left a comment

Choose a reason for hiding this comment

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

Close, need to check other code. We have more modules that use GaussMarkov. I'm surprised the associated unit tests still pass. I guess they were not checking the noise properly?

@Natsoulas Natsoulas force-pushed the feature/gauss-markov-refactor branch 3 times, most recently from 269307b to fdf76b6 Compare December 5, 2024 07:50
@Natsoulas Natsoulas requested a review from schaubh December 5, 2024 07:58
@Natsoulas Natsoulas force-pushed the feature/gauss-markov-refactor branch from fdf76b6 to af24174 Compare December 6, 2024 06:52
Copy link
Contributor

@schaubh schaubh left a comment

Choose a reason for hiding this comment

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

Nice work, all tests and documentation worked as expected on my system as well. This is ready to be pushed.

@Natsoulas Natsoulas merged commit c69a725 into develop Dec 6, 2024
9 checks passed
@Natsoulas Natsoulas deleted the feature/gauss-markov-refactor branch December 6, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request refactor Clean up with no new functionality
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Magnetometer Sensor Noise Std is scaled by a factor of 1.5
2 participants