Skip to content

Commit

Permalink
Added docstring comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Roger Labbe committed Aug 6, 2015
1 parent b01f29b commit 6e6e0f6
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions filterpy/kalman/kalman_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from filterpy.common import setter, setter_1d, setter_scalar, dot3
from filterpy.stats import multivariate_gaussian
import numpy as np
from numpy import dot, zeros, eye, isscalar
import scipy.linalg as linalg
Expand Down Expand Up @@ -136,7 +135,7 @@ def __init__(self, dim_x, dim_z, dim_u=0):

def update(self, z, R=None, H=None):
"""
Add a new measurement (z) to the kalman filter. If z is None, nothing
Add a new measurement (z) to the Kalman filter. If z is None, nothing
is changed.
**Parameters**
Expand All @@ -147,6 +146,11 @@ def update(self, z, R=None, H=None):
R : np.array, scalar, or None
Optionally provide R to override the measurement noise for this
one call, otherwise self.R will be used.
H : np.array, or None
Optionally provide H to override the measurement function for this
one call, otherwise self.H will be used.
"""

if z is None:
Expand Down Expand Up @@ -219,7 +223,8 @@ def test_matrix_dimensions(self):


def predict(self, u=0):
""" Predict next position.
""" Predict next position using the Kalman filter state propagation
equations.
**Parameters**
Expand Down

0 comments on commit 6e6e0f6

Please sign in to comment.