Skip to main content

A simple tool to plot OMPL benchmark results

Project description

ompl_benchmark_plotter

This is an easy-to-use script to quickly generate cost-success graphs (as pdf) from benchmark database file(s) generated in the Open Motion Planning Library (OMPL).

Generating cost-success graphs

Input: Any number of database files.

  ./ompl_benchmark_plotter.py examples/example.db -s

Cost-success Graph

General Options

  • -o, --output-file PDF-FILENAME Specify output pdf filename
  • -s, --show Show output as pdf (requires xdg-open).
  • -v {0,1,2,3}, --verbose {0,1,2,3} Select verbosity level. Default: 1.
  • --quiet Do not show any output. Invalidates any verbose values.

Graph generation Options

NOTE: default values can be found in config/default.json

  • --max-cost MAX-COST Specify upper bound on cost axis.
  • --min-cost MIN-COST Specify lower bound on cost axis.
  • --max-time MAX-TIME Specify upper bound on time axis.
  • --min-time MIN-TIME Specify lower bound on time axis.
  • --fontsize FONTSIZE Fontsize of title and descriptions.
  • --label-fontsize LABEL-FONTSIZE Fontsize of tick labels.
  • --ignore-non-optimal-planner Do not plot non-optimal planner.
  • --title-name TITLE-NAME Set title name
  • --legend-separate-file Print legend as separate file.
  • --legend-below-figure Print legend below graph.
  • --legend-none Do not print legend.

Run unit tests

  pytest

Acknowledgements

@gammell: This repository has been created as a tool to easily generate graphs similar to the ones which Jonathan Gammell has used throughout his work (Check out his work on asymptotically-optimal motion planning.)

@frangrothe: This library is also based upon earlier work by Francesco Grothe, who used cost-success graphs extensively for his work on time-based motion planning (Check it out here: https://github.com/frangrothe/bt-motion-planning).

@servetb and @JayKamat99: For feedback on earlier versions, and advice on improvements.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ompl_benchmark_plotter-0.1.0.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ompl_benchmark_plotter-0.1.0-py3-none-any.whl (2.4 kB view details)

Uploaded Python 3

File details

Details for the file ompl_benchmark_plotter-0.1.0.tar.gz.

File metadata

  • Download URL: ompl_benchmark_plotter-0.1.0.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for ompl_benchmark_plotter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8592fe25924e1156866d2a737f6cce8a58961e89b984edfb015695059b4eeaff
MD5 7656ef4d201f8bece2d17c8530ba7958
BLAKE2b-256 85c5e2ff9b568486b8a392f1061f8b2393a0e72e4f43003a8e83b05e57a03761

See more details on using hashes here.

File details

Details for the file ompl_benchmark_plotter-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ompl_benchmark_plotter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5be9c25da6599fd32c4edc64db25a65a475b4d9114b1d6b35896136e2a516b8
MD5 9900b179538e065d9922dee4c13c1e19
BLAKE2b-256 d637750b5b24f5424d7f7486bbc277e465a69b9d17bcb4abffc18c33ed80ef50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page