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

Adaptive kernel Kalman filter (AKKF) #1014

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Adaptive kernel Kalman filter (AKKF) #1014

wants to merge 12 commits into from

Conversation

jswright-dstl
Copy link
Contributor

This PR adds the Adaptive kernel Kalman filter (AKKF) [1]. The implementation includes the following:

  • Kernel classes
    • QuadraticKernel
    • QuarticKernel
    • GaussianKernel
  • AdaptiveKernelKalmanPredictor
  • AdaptiveKernelKalmanUpdater
  • KernelParticleState
  • AKKF Tutorial

The above implementations are described in [2].

[1] M. Sun, M. E. Davies, I. Proudler and J. R. Hopgood, "Adaptive Kernel Kalman Filter," 2021 Sensor Signal Processing for Defence Conference (SSPD), Edinburgh, United Kingdom, 2021, pp. 1-5, doi: 10.1109/SSPD51364.2021.9541455.
[2] J. S. Wright, J. R. Hopgood, M. E. Davies, I. K. Proudler and M. Sun, "Implementation of Adaptive Kernel Kalman Filter in Stone Soup," 2023 Sensor Signal Processing for Defence Conference (SSPD), Edinburgh, United Kingdom, 2023, pp. 1-5, doi: 10.1109/SSPD57945.2023.10256739.

@jswright-dstl jswright-dstl requested a review from a team as a code owner May 13, 2024 07:38
@jswright-dstl jswright-dstl requested review from hpritchett-dstl and orosoman-dstl and removed request for a team May 13, 2024 07:38
Copy link
Member

@sdhiscocks sdhiscocks left a comment

Choose a reason for hiding this comment

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

Mainly minor comments and suggestions for equations.

Few queries mixed in there.

Haven't looked at tutorial yet.

stonesoup/kernel.py Outdated Show resolved Hide resolved
stonesoup/kernel.py Outdated Show resolved Hide resolved
stonesoup/kernel.py Outdated Show resolved Hide resolved
stonesoup/kernel.py Outdated Show resolved Hide resolved
stonesoup/kernel.py Outdated Show resolved Hide resolved
stonesoup/updater/kernel.py Show resolved Hide resolved
stonesoup/updater/kernel.py Outdated Show resolved Hide resolved
stonesoup/types/state.py Outdated Show resolved Hide resolved
Comment on lines 946 to 952
@property
def mean(self):
return self.state_vector @ self.weight

@property
def covar(self):
return self.state_vector @ self.kernel_covar @ self.state_vector.T
Copy link
Member

Choose a reason for hiding this comment

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

No weight for covar?

Comment on lines +378 to +381
# %%

plotter.plot_tracks(track, [0, 2], particle=True)
plotter.fig
Copy link
Member

Choose a reason for hiding this comment

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

Adding the comment below should use last image for gallery thumbnail, which I think is better.

Suggested change
# %%
plotter.plot_tracks(track, [0, 2], particle=True)
plotter.fig
# %%
# sphinx_gallery_thumbnail_number = -1
plotter.plot_tracks(track, [0, 2], track_label='AKKF - quadratic', color='royalblue', particle=True)
plotter.fig

Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.66%. Comparing base (ab6af2b) to head (86060fa).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1014      +/-   ##
==========================================
+ Coverage   93.60%   93.66%   +0.06%     
==========================================
  Files         202      205       +3     
  Lines       12990    13125     +135     
  Branches     2651     2668      +17     
==========================================
+ Hits        12159    12294     +135     
  Misses        588      588              
  Partials      243      243              
Flag Coverage Δ
integration 66.48% <84.55%> (+0.20%) ⬆️
unittests 89.31% <100.00%> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

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.

None yet

2 participants