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
  • Subpackages
    • tracktable.core module
      • Module contents
    • tracktable.feature module
      • Submodules
      • tracktable.feature.annotations module
      • Module contents
    • tracktable.filter module
      • Submodules
        • tracktable.filter.trajectory module
          • Module contents
      • Module contents
    • tracktable.info module
      • Submodules
      • tracktable.info.airports module
      • tracktable.info.cities module
      • tracktable.info.timezones module
      • Module contents
    • tracktable.render
      • Submodules
        • tracktable.render.clock module
        • tracktable.render.colormaps module
        • tracktable.render.histogram2d module
        • tracktable.render.mapmaker module
        • tracktable.render.maps module
        • tracktable.render.paths module
      • Module contents
    • tracktable.script_helpers package
      • Submodules
        • tracktable.script_helpers.argument_groups package
          • tracktable.script_helpers.argument_groups.dt_point_loader 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
    • tracktable.source package
      • Submodules
      • tracktable.source.combine module
      • tracktable.source.path_point_source module
      • tracktable.source.trajectory module
      • Module contents
  • Module contents
• tracktable.core module
  • Module contents
• tracktable.core.geomath module
• tracktable.core.log module
• tracktable.core.simple_timezone module
• tracktable.core.timestamp module
• tracktable.feature module
  • Submodules
  • tracktable.feature.annotations module
  • Module contents
• tracktable.filter module
  • Submodules
    • tracktable.filter.trajectory module
      • Module contents
  • Module contents
• tracktable.info module
  • Submodules
  • tracktable.info.airports module
  • tracktable.info.cities module
  • tracktable.info.timezones module
  • Module contents
• tracktable.render
  • Submodules
    • tracktable.render.clock module
    • tracktable.render.colormaps module
    • tracktable.render.histogram2d module
    • tracktable.render.mapmaker module
    • tracktable.render.maps module
    • tracktable.render.paths module
  • Module contents
• tracktable.script_helpers package
  • Submodules
    • tracktable.script_helpers.argument_groups package
      • tracktable.script_helpers.argument_groups.dt_point_loader 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++ 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.

• TracktableCore module
• Tracktable Point Domains
  • Terrestrial Domain
  • 2D Cartesian Domain
  • 3D Cartesian Domain
• TracktableIO module
  • Module contents
• TracktableAnalysis module
  • Module contents

Todo

Clean up table of contents. Look at tracktable.render.rst for an example.

Todo

Write an explanatory page for the Python domain module.