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

Basic Documentation for KF test #781

Merged
merged 3 commits into from
Jun 10, 2021
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions python/gtsam/tests/test_KalmanFilter.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@
class TestKalmanFilter(GtsamTestCase):

def test_KalmanFilter(self):

# Kalman Filter Definitions:
Copy link
Member

Choose a reason for hiding this comment

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

Cool, but multi-line comments in python are typically done using """ ... """

If using VS Code, also pays to install the "docstring" extension.

Patch branch and I'll approve, merge

#
# F - State Transition Model
# B - Control Input Model
# u - Control Vector
# modelQ - Covariance of the process Noise (input for KalmanFilter object) - sigma as input
# Q - Covariance of the process Noise (for reference calculation) - sigma^2 as input
# H - Observation Model
# z1 - Observation iteration 1
# z2 - Observation iteration 2
# z3 - observation iteration 3
# modelR - Covariance of the observation Noise (input for KalmanFilter object) - sigma as input
# R - Covariance of the observation Noise (for reference calculation) - sigma^2 as input

F = np.eye(2)
B = np.eye(2)
u = np.array([1.0, 0.0])
Expand Down