Metadata-Version: 2.1
Name: cnspy-trajectory
Version: 0.1.1
Summary: Trajectory in SE(3) space with utilities.
Home-page: https://github.com/aau-cns/cnspy_trajectory/
Author: Roland Jung
Author-email: roland.jung@aau.at
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/aau-cns/cnspy_trajectory/issues
Description: # The cnspy_trajectory Package
        
        A [Trajectory](./cnspy_trajectory/Trajectory.py) object consists of a matrix of positions, orientations (Quaternions) and associated timestamps.
        The object can be created by passing the these three matrices or by passing a `Pandas` `DataFrame` object containing them. 
        The `DataFrame` will be converted using the class `TUMCSV2DataFrame`.
        
        A trajectory object offers some conversions, load/store methods, plot, spatial transformations, etc.  
        
        A `TrajectoryEstimated` is a specialization of a `Trajectory`, holding a covariances of the position and orientation to the timestamps, which can be loaded form a `DataFrame` too.
        
        The `TrajectoryPlotter` offers methods to visualize a (or multiple) `Trajectory` objects.
        
        ![class_diagram](./doc/class_diagram.png "folder structure")
        
        
        ## Installation
        
        Install the current code base from GitHub and pip install a link to that cloned copy
        ```
        git clone https://github.com/aau-cns/cnspy_trajectory.git
        cd cnspy_trajectory
        pip install -e .
        ```
        
        ## Dependencies
        
        It is part of the [cnspy eco-system](hhttps://github.com/aau-cns/cnspy_eco_system_test) of the [cns-github](https://github.com/aau-cns) group.  
        
        * [numpy]()
        * [matplotlib]()
        * [pandas]()
        * [scipy]()
        * [cnspy_numpy_utils](https://github.com/aau-cns/cnspy_numpy_utils)
        * [cnspy_csv2dataframe](https://github.com/aau-cns/cnspy_csv2dataframe)
        * [cnspy_spatial_csv_formats](https://github.com/aau-cns/cnspy_spatial_csv_formats)
        * [cnspy_trajectory](https://github.com/aau-cns/cnspy_trajectory)  
        * [matplotlib.pyplot]()
        
        
        ## Examples
        
        Please refer to the unit-tests `Trajectory_Test` and `TrajectoryEstimated_Test` in `Trajectory/TrajectoryEstimated.py`.
        For plotting options to the unit-test `TrajectoryPlotter_Test`.
        
        ### Pose plot
        ![pose](./doc/pose_plot.png "folder structure")
        
        ### Pose plot 3D
        ![plot3d](./doc/plot_3D.png "folder structure")
        
        ### Mutli pose plot 3D
        ![multi](./doc/multi.png "folder structure")
        
        
        ## License
        
        Software License Agreement (GNU GPLv3  License), refer to the LICENSE file.
        
        *Sharing is caring!* - [Roland Jung](https://github.com/jungr-ait)  
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
