Reference Documentation¶
Todo
In a future release there will be a detailed explanation of the differences between the C++ and Python interfaces and how to go back and forth between them.
Python Interface¶
Right now Tracktable’s functions are accessible principally via the Python interface. We prefer to implement things in Python first for ease, speed and malleability, then choose parts to re-implement in C++ based on speed, memory usage and algorithmic needs.
- tracktable package
- Submodules
- tracktable.analysis module
- tracktable.core module
- Submodules
- tracktable.core.conversions module
- tracktable.core.core_types module
- tracktable.core.geomath module
- tracktable.core.log module
- tracktable.core.misc module
- tracktable.core.register_core_types module
- tracktable.core.simple_timezone module
- tracktable.core.test_utilities module
- tracktable.core.testutils module
- tracktable.core.timestamp module
- Module contents
- Submodules
- tracktable.domain module
- tracktable.feature module
- tracktable.filter module
- tracktable.info module
- tracktable.io module
- tracktable.render
- Submodules
- Module contents
- tracktable.script_helpers module
- Submodules
- tracktable.script_helpers.argparse module
- tracktable.script_helpers.argument_groups module
- Submodules
- tracktable.script_helpers.argument_groups.dt_point_loader module
- tracktable.script_helpers.argument_groups.image module
- tracktable.script_helpers.argument_groups.mapmaker module
- tracktable.script_helpers.argument_groups.movie_rendering module
- tracktable.script_helpers.argument_groups.parallel module
- tracktable.script_helpers.argument_groups.trajectory_assembly module
- tracktable.script_helpers.argument_groups.trajectory_rendering module
- tracktable.script_helpers.argument_groups.utilities module
- Module contents
- Submodules
- Module contents
- Submodules
- tracktable.source module
- Module contents
- Submodules
- tracktable.analysis module
- tracktable.core module
- Submodules
- tracktable.core.conversions module
- tracktable.core.core_types module
- tracktable.core.geomath module
- tracktable.core.log module
- tracktable.core.misc module
- tracktable.core.register_core_types module
- tracktable.core.simple_timezone module
- tracktable.core.test_utilities module
- tracktable.core.testutils module
- tracktable.core.timestamp module
- Module contents
- Submodules
- tracktable.domain module
- tracktable.feature module
- tracktable.filter module
- tracktable.info module
- tracktable.io module
- tracktable.render
- Submodules
- Module contents
- tracktable.script_helpers module
- Submodules
- tracktable.script_helpers.argparse module
- tracktable.script_helpers.argument_groups module
- Submodules
- tracktable.script_helpers.argument_groups.dt_point_loader module
- tracktable.script_helpers.argument_groups.image module
- tracktable.script_helpers.argument_groups.mapmaker module
- tracktable.script_helpers.argument_groups.movie_rendering module
- tracktable.script_helpers.argument_groups.parallel module
- tracktable.script_helpers.argument_groups.trajectory_assembly module
- tracktable.script_helpers.argument_groups.trajectory_rendering module
- tracktable.script_helpers.argument_groups.utilities module
- Module contents
- Submodules
- Module contents
- Submodules
- tracktable.source module
C++ Interface¶
In this release there is minimal functionality available directly in
C++. We have the point hierarchy ending in TrajectoryPoint
(a 2D
point on a globe) and PointBaseCartesian
(an N-dimensional point
– bring your own dimension) as well as the Trajectory class. All of
these have the necessary typedefs and traits to be used with the
boost::geometry
library. We also have
DelimitedTextPointReader
in the TracktableIO
library.
Our first release is focused on getting enough capability out there to start rendering maps and movies.
- Tracktable Analysis Module
- Tracktable Core Module
- Module Contents
- Submodules
- Box Module
- FloatingPointComparison Module
- GeometricMean Module
- GeometricMedian Module
- Logging Module
- MemoryUse Module
- PointArithmetic Module
- PointBase Module
- PointCartesian Module
- PointLonLat Module
- PropertyConverter Module
- PointArithmetic Module
- PropertyValue Module
- Timestamp Module
- TimestampConverter Module
- TracktableCommon Module
- Trajectory Module
- TrajectoryPoint Module
- TimestampConverter Module
- Tracktable Point Domains
- Tracktable IO module
- Tracktable Namespaces
Todo
Clean up table of contents. Look at tracktable.render.rst for an example.
Todo
Write an explanatory page for the Python domain module.