API Reference Documentation

The documentation in the section has been autogenerated from the Python and C++ internal documentation describing algorithms, functions, classes, parameters, inputs and outputs.

The Python and C++ interfaces share the same functionality, but they are accessed through different interfaces. We prefer to implement things in Python first for ease, development speed and malleability, then choose certain components to re-implement in C++ based on runtime speed, memory usage and algorithmic needs. However, there do exist C++ modules that have been Python wrapped so they can be utilized directly in the Python interface to achieve the maximum performance out of the given algorithms. These Python wrapped C++ algorithms are further described under the tracktable.lib module documentation.

Python API

The Python interface is the primary way to access and utilize Tracktable’s functions. This interface provides the same access to functionality as you would find if you were directly accessing the C++ interface. This includes functionality to read, write, create, modify and analyze trajectories and points as well as rendering movies and images. Detailed information about each of the operations listed above and information about the specifics about points and trajectories can be found in the modules listed below.

Note

There may be functionality available in the Python interface that is unavailable in the C++ interface.

• tracktable.algorithms module
  • Submodules
    • tracktable.algorithms.boxiness module
      • Module contents
    • tracktable.algorithms.dbscan module
      • Module contents
    • tracktable.algorithms.distance_geometry module
      • Module contents
  • Module contents
• tracktable.analysis module
  • Submodules
    • tracktable.applications.assemble_trajectories module
      • Module contents
    • tracktable.algorithms.dbscan module
      • Module contents
    • tracktable.algorithms.distance_geometry module
      • Module contents
    • tracktable.domain.rtree module
      • Module contents
• tracktable.applications module
  • Submodules
    • tracktable.applications.anomaly_detection module
      • Module contents
    • tracktable.applications.assemble_trajectories module
      • Module contents
    • tracktable.applications.cluster module
      • Module contents
    • tracktable.applications.prediction module
      • Module contents
    • tracktable.applications.trajectory_splitter module
      • Module contents
  • Module contents
• tracktable.core module
  • Submodules
    • tracktable.core.conversions module
      • Module contents
    • tracktable.core.core_types module
      • Module contents
    • tracktable.core.geomath module
      • Module contents
    • tracktable.core.log module
      • Module contents
    • tracktable.core.misc module
      • Module contents
    • tracktable.core.simple_timezone module
      • Module contents
    • tracktable.core.test_utilities module
      • Module contents
    • tracktable.core.testutils module
      • Module contents
    • tracktable.core.timestamp module
      • Module contents
  • Module contents
• tracktable.data_generators module
  • Submodules
    • tracktable.data_generators.heatmap_point module
      • Module contents
    • tracktable.data_generators.point module
      • Module contents
    • tracktable.data_generators.trajectory module
      • Module contents
  • Module contents
• tracktable.domain module
  • Submodules
    • tracktable.domain.cartesian2d module
      • Module contents
    • tracktable.domain.cartesian3d module
      • Module contents
    • tracktable.domain.feature_vectors module
      • Module contents
    • tracktable.domain.rtree module
      • Module contents
    • tracktable.domain.terrestrial module
      • Module contents
  • Module contents
• tracktable.examples module
  • Module contents
• tracktable.feature module
  • Submodules
    • tracktable.feature.annotations module
      • Module contents
    • tracktable.feature.interleave_points module
      • Module contents
    • tracktable.feature.interpolated_points module
      • Module contents
  • Module contents
• tracktable.filter module
  • Submodules
    • tracktable.filter.trajectory module
      • Module contents
  • Module contents
• tracktable.info module
  • Submodules
    • tracktable.info.airports module
      • Module contents
    • tracktable.info.borders module
      • Module contents
    • tracktable.info.cities module
      • Module contents
    • tracktable.info.ports module
      • Module contents
    • tracktable.info.rivers module
      • Module contents
    • tracktable.info.shorelines module
      • Module contents
    • tracktable.info.timezones module
      • Module contents
  • Module contents
• tracktable.rw module
  • Submodules
    • tracktable.rw.load module
      • Module contents
    • tracktable.rw.point module
      • Module contents
    • tracktable.rw.read_write_dictionary module
      • Module contents
    • tracktable.rw.read_write_json module
      • Module contents
  • Module contents
• tracktable.lib module
  • Submodules
    • tracktable.lib._cartesian2d module
      • Module contents
    • tracktable.lib._cartesian3d module
      • Module contents
    • tracktable.lib._core_types module
      • Module contents
    • tracktable.lib._dbscan_clustering module
      • Module contents
    • tracktable.lib._distance_geometry module
      • Module contents
    • tracktable.lib._domain_algorithm_overloads module
      • Module contents
    • tracktable.lib._feature_vector_points module
      • Module contents
    • tracktable.lib._logging module
      • Module contents
    • tracktable.lib._rtree module
      • Module contents
    • tracktable.lib._terrestrial module
      • Module contents
  • Module contents
• tracktable.render module
  • User Accessible Submodules
    • tracktable.render.mapmaker module
      • Module contents
    • tracktable.render.render_heatmap module
      • Module contents
    • tracktable.render.render_map module
      • Module contents
    • tracktable.render.render_movie module
      • Module contents
    • tracktable.render.render_trajectories module
      • Module contents
  • Non-User Accessible Submodules
    • tracktable.render.backends.bokeh_backend module
      • Module contents
    • tracktable.render.backends.cartopy_backend module
      • Module contents
    • tracktable.render.backends.ffmpeg_backend module
      • Module contents
    • tracktable.render.backends.folium_backend module
      • Module contents
    • tracktable.render.backends.ipyleaflet_backend module
      • Module contents
    • tracktable.render.map_decoration.clock module
      • Module contents
    • tracktable.render.map_decoration.coloring module
      • Module contents
    • tracktable.render.map_decoration.colormaps module
      • Module contents
    • tracktable.render.map_decoration.geographic_decoration module
      • Module contents
    • tracktable.render.map_processing.common_processing module
      • Module contents
    • tracktable.render.map_processing.maps module
      • Module contents
    • tracktable.render.map_processing.movies module
      • Module contents
    • tracktable.render.map_processing.parallel_movies module
      • Module contents
    • tracktable.render.map_processing.paths module
      • Module contents
  • Module contents
• tracktable.script_helpers module
  • Submodules
    • tracktable.script_helpers.argparse module
      • Module contents
    • 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
  • Module contents

C++ API

The C++ interface provides access to all of the core components of the Tracktable library. This includes functionality to read, write, create, modify and analyze trajectories and points as well as rendering movies and images. Detailed information about each of the operations listed above and information about the specifics about points and trajectories can be found in the modules listed below.

Note

There may be functionality available in the C++ interface that is unavailable in the Python interface.

• Tracktable Analysis Module
  • Module Contents
  • Submodules
    • AssembleTrajectories Module
      • Module contents
    • ComputeDBSCANClustering Module
      • Module contents
    • DistanceGeometery Module
      • Module contents
    • GreatFitCircle Module
      • Module contents
    • RTree Module
      • Module contents
• Tracktable Core Module
  • Module Contents
  • Submodules
    • Box Module
      • Module Contents
    • Bearing Module
      • Module Contents
    • ConvexHull Module
      • Module Contents
    • Distance Module
      • Module Contents
    • EndToEnd Module
      • Module Contents
    • Extrapolate Module
      • Module Contents
    • Interpolate Module
      • Module Contents
    • Intersects Module
      • Module Contents
    • Length Module
      • Module Contents
    • LengthFractionAtPoint Module
      • Module Contents
    • PointAtFraction Module
      • Module Contents
    • PointAtTime Module
      • Module Contents
    • RadiusOfGyration Module
      • Module Contents
    • SimplifyLinestring Module
      • Module Contents
    • SpeedBetween Module
      • Module Contents
    • SphericalCoordinateAccess Module
      • Module Contents
    • SubsetDuringInterval Module
      • Module Contents
    • TimeAtFraction Module
      • Module Contents
    • TimeAtFractionAtPoint Module
      • Module Contents
    • TransferProperties Module
      • Module Contents
    • TurnAngle Module
      • Module Contents
    • FloatingPointComparison Module
      • Module Contents
    • GeometricMean Module
      • Module Contents
    • GeometricMedian Module
      • Module Contents
    • Logging Module
      • Module Contents
    • MemoryUse Module
      • Module Contents
    • PointArithmetic Module
      • Module Contents
    • PointBase Module
      • Module Contents
    • PointCartesian Module
      • Module Contents
    • PointLonLat Module
      • Module Contents
    • PropertyConverter Module
      • Module Contents
    • PropertyMap Module
      • Module Contents
    • PropertyValue Module
      • Module Contents
    • Timestamp Module
      • Module Contents
    • TimestampConverter Module
      • Module Contents
    • TracktableCommon Module
      • Module Contents
    • Trajectory Module
      • Module Contents
    • TrajectoryPoint Module
      • Module Contents
    • TimestampConverter Module
      • Module Contents
• Tracktable Data Generator Module
  • Module Contents
  • Submodules
    • PointGenerator Module
      • Module Contents
• Tracktable Point Domains
  • Module contents
  • Domains
    • 2D Cartesian Domain
      • Specification
      • Units
      • Module Contents
    • 3D Cartesian Domain
      • Specification
      • Units
      • Module Contents
    • Feature Vectors Domain
      • Module Contents
    • Terrestrial Domain
      • Specification
      • Units
      • Module Contents
• Tracktable RW Module
  • Module contents
  • Submodules
    • GenericReader module
      • Module contents
    • KmlOut module
      • Module contents
    • LineReader module
      • Module contents
    • ParseExceptions module
      • Module contents
    • PointFromTokensReader module
      • Module contents
    • PointReader module
      • Module contents
    • PointWriter module
      • Module contents
    • SkipCommentsReader module
      • Module contents
    • StringTokenizingReader module
      • Module contents
    • TokenWriter module
      • Module contents
    • TrajectoryReader module
      • Module contents
    • TrajectoryWriter module
      • Module contents
• Tracktable Namespaces
  • Namespaces
    • Algorithms Namespace
    • Conversions Namespace
    • Log Namespace
    • Settings Namespace
    • Traits Namespace