Metadata-Version: 1.1
Name: minidemoKalmanFilter
Version: 1.0.0
Summary: minidemoKalmanFilter - Minimal Demo. of Kalman Filters (Linear/Extended/Unscented)
Home-page: https://github.com/sken10/minidemoKalmanFilter
Author: Kenichi SHIRAKAWA
Author-email: shirakawa.kenichi@gmail.com
License: MIT License
Description: **********************************************************************************
        minidemoKalmanFilter - Minimal Demo. of Kalman Filters (Linear/Extended/Unscented)
        **********************************************************************************
        
        Provides
         1. Minimal Kalman Filter classes (Linear, Extended and Unscented).
         2. Interactive demonstration and it's snapshot.
         
        This package is very simple, and may suitable for educational use.
         | About 100 executable lines for LKF/EKF/UKF totally.
         | Demo program will show you the essence (assumption and limitation)
         | of Kalman Filter.
        
        Files
        -----
        
        ``filter.py``
          An implementation of minimal Kalman Filter (LKF/EKF/UKF included).
        
        Demos
        -----
        
        Interactive demo
        ^^^^^^^^^^^^^^^^
        
        Interactive style demo requires ``numpy`` and ``matplotlib``.
        Touch sliders to change the parameter of the filter,
        and you will find the estimated results updated on your screen.
        Some snapshots are included in the package directory (snapshot_*.png).
        
        ::
        
            python demo_ukf_gui.py
        
        Batch demo
        ^^^^^^^^^^
        
        Batch style demo (console version) requires ``numpy``.
        This demo estimates the position and velocity of 2-dimensinal 
        linear uniform motion, and output results to the console.
        You can choose the filter class (LKF,EKF,UKF) by comman line.
        
        LKF, EFK and UKF gives almost same reseults for such a linear 
        problem here. Please extend significiant of output to confirm 
        the differences.
        
        ::
        
            python demo_ukf.py > out_ukf.txt
        
        Requirements
        ------------
        
        Uses NumPy and Matplotlib(for interactive demo).
        
        License
        -------
        
        Copyright (c) 2018 Kenich SHIRAKAWA
        
        This is licensed under MIT license.
        See Licence.txt for more information.
        
        Thanks
        ------
        
        The basic design of unscented transformation class is based on 
        the Sam Burden's work (see https://github.com/sburden/uk ukf.py).
        
        
Keywords: Kalman UKF EKF LKF
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
