trackanimation 1.0.5
GPS Track Animation Library
License: Apache License, Version 2.0
Keywords: GPS GPX animation map geospatial geopositioning

Track Animation
===============

**Track Animation** is a Python 2 and 3 library that provides an easy and user-adjustable way of **creating visualizations from GPS data** easily and without any kind of technical tie for the user. It allows to import GPS data from **GPX** (GPS eXchange Format) and CSV files in order to manipulate it and, finally, create **videos**, **images**, sequences of images or **interactive maps** to analyze the tracks based on their elevation, speed, duration or any other indicator.

The main third party libraries that **Track Animation** uses are `gpxpy <https://github.com/tkrajina/gpxpy>`__ to parse and read GPX files, `pandas <http://pandas.pydata.org/>`__ to manipulate all the GPS data and `matplotlib <https://matplotlib.org/>`__ to plot it and save the visualizations.

To create a basic visualization, simply read the files and pass them to the *AnimationTrack* class:

.. code:: python

    import trackanimation
    from trackanimation.animation import AnimationTrack

    input_directory = "example-routes/"
    ibiza_trk = trackanimation.read_track(input_directory)

    fig = AnimationTrack(df_points=ibiza_trk, dpi=300, bg_map=True, map_transparency=0.5)
    fig.make_video(output_file='simple-example', framerate=60, linewidth=1.0)

|Simple-Example|


Dependencies
------------
* `gpxpy <https://github.com/tkrajina/gpxpy>`__
* `pandas <http://pandas.pydata.org/>`__
* `matplotlib <https://matplotlib.org/>`__
* `geopy <https://github.com/geopy/geopy>`__
* `smopy <https://github.com/rossant/smopy>`__
* `mplleaflet <https://github.com/jwass/mplleaflet>`__
* `pillow <https://python-pillow.org/>`__
* `tqdm <https://github.com/noamraph/tqdm>`__
* `FFmpeg <https://ffmpeg.org/>`__


Installation
------------
Install **Track Animation** using `pip <http://www.pip-installer.org/en/latest/>`__ with:

    pip install trackanimation

Or, `download the source files from PyPI <https://pypi.python.org/pypi/trackanimation>`__.


Getting Started
---------------
You can find the following examples in the `examples.py <https://github.com/JoanMartin/trackanimation/blob/master/examples.py>`__ file.


Filtering by place
~~~~~~~~~~~~~~~~~~
It is possible to filter a set of tracks to retrieve only the points that belong to an specific place or the whole tracks that have passed by there. With the function *timeVideoNormalize*, all the tracks will start and end at the same time in the video, specyfing its duration and frame rate in the parameters. In the next example, the video created has a duration of 10 seconds with 10 frames per second.

.. code:: python

    import trackanimation
    from trackanimation.animation import AnimationTrack

    input_directory = "example-routes/"
    ibiza_trk = trackanimation.read_track(input_directory)
    sant_josep_trk = ibiza_trk.get_tracks_by_place('Sant Josep de sa Talaia', only_points=False)
    sant_josep_trk = sant_josep_trk.time_video_normalize(time=10, framerate=10)

    fig = AnimationTrack(df_points=sant_josep_trk, dpi=300, bg_map=True, map_transparency=0.5)
    fig.make_video(output_file='filtering-by-place', framerate=10, linewidth=1.0)

|Filtering-Place|


Coloring tracks by one indicator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Furthermore, an indicator of the tracks can be visualized as a palette of colors to make the analysis and the interpretation of the data easier and effective.

.. code:: python

    import trackanimation
    from trackanimation.animation import AnimationTrack

    input_directory = "example-routes/ibiza.csv"
    ibiza_trk = trackanimation.read_track(input_directory)
    ibiza_trk = ibiza_trk.time_video_normalize(time=10, framerate=10)
    ibiza_trk = ibiza_trk.set_colors('Speed', individual_tracks=True)

    fig = AnimationTrack(df_points=ibiza_trk, dpi=300, bg_map=True, map_transparency=0.5)
    fig.make_video(output_file='coloring-map-by-speed', framerate=10, linewidth=1.0)

    # Variable 'bg_map' must be to False in order to create an interactive map
    fig = AnimationTrack(df_points=ibiza_trk, dpi=300, bg_map=False, map_transparency=0.5)
    fig.make_map(output_file='coloring-map-by-speed')

`Click to view the interactive map <http://htmlpreview.github.io/?https://raw.githubusercontent.com/JoanMartin/trackanimation/master/example-results/coloring-map-by-speed.html>`__

|Coloring-Tracks|


Visualizing multiple set of tracks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Multiple sets of tracks can be plotted independently in the same visualization to compare them.

.. code:: python

    import trackanimation
    from trackanimation.animation import AnimationTrack

    input_directory = "example-routes/"
    ibiza_trk = trackanimation.read_track(input_directory)
    sant_josep_trk = ibiza_trk.get_tracks_by_place('Sant Josep de sa Talaia', only_points=False)

    ibiza_trk = ibiza_trk.set_colors('Speed', individual_tracks=True)
    sant_josep_trk = sant_josep_trk.set_colors('Speed', individual_tracks=True)

    fig = AnimationTrack(df_points=[ibiza_trk, sant_josep_trk], dpi=300, bg_map=True, map_transparency=0.5)
    fig.make_image(output_file='multiple-axes')

|Multiple-Axes|


Documentation
-------------
More documentation and examples can be found at `Track Animation PDF document <https://github.com/JoanMartin/trackanimation/blob/master/Documentation.pdf>`__.



.. |Simple-Example| image:: https://raw.githubusercontent.com/JoanMartin/trackanimation/master/example-results/simple-example.gif
.. |Filtering-Place| image:: https://raw.githubusercontent.com/JoanMartin/trackanimation/master/example-results/filtering-by-place.gif
.. |Coloring-Tracks| image:: https://raw.githubusercontent.com/JoanMartin/trackanimation/master/example-results/coloring-map-by-speed.gif
.. |Multiple-Axes| image:: https://raw.githubusercontent.com/JoanMartin/trackanimation/master/example-results/multiple-axes-auto.png