Skip to content

Commit

Permalink
feat: update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
zhenyuen committed Nov 11, 2024
1 parent 67a6dcb commit bef498c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
12 changes: 11 additions & 1 deletion stonesoup/predictor/particle.py
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,17 @@ def predict(self, prior, timestamp=None, **kwargs):


class MarginalisedParticlePredictor(ParticlePredictor):
"""Implementation of the Marginalised Particle Filter predictor"""
"""Implementation of the Marginalised Particle Filter (MPF) predictor.
The MPF which partitions the state into:
1. linear Gaussian
2. non-linear and possibly non-Gaussian
It uses a Kalman filter to handle the linear Gaussian states, and
a traditional particle filter to infer the non-linear states.
See Cappe, Godsill, Moulines (2007) for more details.
"""

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
Expand Down
12 changes: 11 additions & 1 deletion stonesoup/updater/particle.py
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,17 @@ def _get_measurement_loglikelihoods(self, prediction, detections):


class MarginalisedParticleUpdater(ParticleUpdater):
"""Implementation of the Marginalised Particle Filter updater"""
"""Implementation of the Marginalised Particle Filter (MPF) updater
The MPF which partitions the state into:
1. linear Gaussian
2. non-linear and possibly non-Gaussian
It uses a Kalman filter to handle the linear Gaussian states, and
a traditional particle filter to infer the non-linear states.
See Cappe, Godsill, Moulines (2007) for more details.
"""

def _measurement_matrix(self, predicted_state=None, measurement_model=None, **kwargs):
# H
Expand Down

0 comments on commit bef498c

Please sign in to comment.