PageSourceSearch

https://docs.mrpt.org/reference/latest/

html mrpt.org collected 2026-09-25 18:18:35 UTC 13,195 bytes, 261 lines download raw bytes

1<!DOCTYPE html>
2<html class="writer-html5" lang="en" >
3<head>
4  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
5
6  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7  <title>MRPT &mdash; MRPT 2.15.13 documentation</title>
8      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10      <link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
11      <link rel="stylesheet" href="_static/doxyrest-pygments.css" type="text/css" />
12      <link rel="stylesheet" href="_static/doxyrest-sphinx_rtd_theme.css" type="text/css" />
13      <link rel="stylesheet" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" type="text/css" />
14    <link rel="canonical" href="https://docs.mrpt.org/reference/latest/index.html" />
15
16  <!--[if lt IE 9]>
17    
17<script src="_static/js/html5shiv.min.js"></script>
17
18  <![endif]-->
19  
20        
20<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
20
21        
21<script src="_static/jquery.js"></script>
21
22        
22<script src="_static/underscore.js"></script>
22
23        
23<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
23
24        
24<script src="_static/doctools.js"></script>
24
25        
25<script src="_static/sphinx_highlight.js"></script>
25
26        
26<script src="_static/target-highlight.js"></script>
26
27        
27<script src="_static/design-tabs.js"></script>
27
28    
28<script src="_static/js/theme.js"></script>
28
29<!-- Global site tag (gtag.js) - Google Analytics -->
vendor: 64 bytes, lines 29-30
29
30<script async src="https://www.googletagmanager.com/gtag/js?id=
30UA-21128561-10
vendor: 12 bytes, line 30
30"></script>
31<script>
32  
vendor: 133 bytes, lines 32-35
32window.dataLayer = window.dataLayer || [];
33  function gtag(){dataLayer.push(arguments);}
34  gtag('js', new Date());
35  gtag('config', '
35UA-21128561-10
vendor: 4 bytes, line 35
35');
36</script>
36
37
38    <link rel="index" title="Index" href="genindex.html" />
39    <link rel="search" title="Search" href="search.html" />
40    <link rel="next" title="Download MRPT" href="download-mrpt.html" /> 
41</head>
42
43<body class="wy-body-for-nav"> 
44  <div class="wy-grid-for-nav">
45    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
46      <div class="wy-side-scroll">
47        <div class="wy-side-nav-search" >
48
49
50          
51          
52          <a href="#" class="icon icon-home">
53            MRPT
54          </a>
55              <div class="version">
56                2.15.13
57              </div>
58<div role="search">
59  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
60    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
61    <input type="hidden" name="check_keywords" value="yes" />
62    <input type="hidden" name="area" value="default" />
63  </form>
64</div>
65<script>
66function onMRPTVersionChange() {
67    var selectBox = document.getElementById("docsVersionSelectBox");
68    const newVersion = selectBox.options[selectBox.selectedIndex].value;
69    var curURL = window.location.href;
70    const lastURLSegment = curURL;
71    const newURL = window.location.protocol + "//" + window.location.host + "/" +
72        "reference/" + newVersion + "/" +
73        window.location.pathname.split("/").pop();
74    window.location.href = newURL;
75}
76var req = new XMLHttpRequest();
77 req.onload = function(){
78     var versions = JSON.parse(this.responseText);
79     var versionDiv = document.getElementsByClassName('version')[0];
80     var curVer = versionDiv.innerHTML.trim();
81     var s='<select id="docsVersionSelectBox" onchange="onMRPTVersionChange();">\n';
82     for(var i = 0; i < versions.length; i++) {
83       var v = versions[i];
84       var vstr = v;
85       if (v.charAt(0)>='0' && v.charAt(0)<='9') {
86         vstr = 'v'+vstr;
87       }
88       s=s+ '<option value="' +v+'"';
89       if (curVer==v) {s=s+' selected';}
90       s=s+'">'+ vstr + '</option>\n';
91     }
92     s = s + '</select>\n';
93     versionDiv.innerHTML = s;
94 };
95 req.open('GET', '../versions.txt');
96 req.send();
97</script>
97
98
99        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
100              <p class="caption" role="heading"><span class="caption-text">Get it</span></p>
101<ul>
102<li class="toctree-l1"><a class="reference internal" href="download-mrpt.html">Download MRPT</a></li>
103<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling</a></li>
104<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
105<li class="toctree-l1"><a class="reference internal" href="page_changelog.html">Change Log</a></li>
106<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
107</ul>
108<p class="caption" role="heading"><span class="caption-text">Learn it</span></p>
109<ul>
110<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
111<li class="toctree-l1"><a class="reference internal" href="applications.html">Applications</a></li>
112<li class="toctree-l1"><a class="reference internal" href="examples.html">C++ examples</a></li>
113<li class="toctree-l1"><a class="reference internal" href="python_examples.html">Python examples</a></li>
114<li class="toctree-l1"><a class="reference internal" href="wrappers.html">Wrappers</a></li>
115<li class="toctree-l1"><a class="reference internal" href="supported-sensors.html">Supported sensors</a></li>
116<li class="toctree-l1"><a class="reference internal" href="unit_testing.html">Unit testing in MRPT</a></li>
117<li class="toctree-l1"><a class="reference internal" href="children-projects.html">Children projects</a></li>
118</ul>
119<p class="caption" role="heading"><span class="caption-text">Advanced</span></p>
120<ul>
121<li class="toctree-l1"><a class="reference internal" href="modules.html">MRPT modules</a></li>
122<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
123<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Bibliography</a></li>
124<li class="toctree-l1"><a class="reference internal" href="doxygen-index.html">C++ API</a></li>
125<li class="toctree-l1"><a class="reference external" href="https://docs.mrpt.org/reference/">Docs for other versions</a></li>
126</ul>
127
128        </div>
129      </div>
130    </nav>
131
132    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
133          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
134          <a href="#">MRPT</a>
135      </nav>
136
137      <div class="wy-nav-content">
138        <div class="rst-content">
139          <div role="navigation" aria-label="Page navigation">
140  <ul class="wy-breadcrumbs">
141      <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
142      <li class="breadcrumb-item active">MRPT</li>
143      <li class="wy-breadcrumbs-aside">
144              <a href="https://github.com/MRPT/mrpt/blob/develop/doc/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
145      </li>
146  </ul>
147  <hr/>
148</div>
149          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
150           <div itemprop="articleBody">
151             
152  <section id="mrpt">
153<h1>MRPT<a class="headerlink" href="#mrpt" title="Permalink to this heading"></a></h1>
154<div class="toctree-wrapper compound">
155</div>
156<div class="toctree-wrapper compound">
157</div>
158<div class="toctree-wrapper compound">
159</div>
160<img alt="MRPT demo usages" class="align-right" src="https://mrpt.github.io/imgs/mrpt-videos-mix2.gif" />
161<section id="about">
162<h2>About<a class="headerlink" href="#about" title="Permalink to this heading"></a></h2>
163<p>Mobile Robot Programming Toolkit (MRPT) provides developers with
164portable and well-tested <a class="reference external" href="applications.html">applications</a> and
165<a class="reference external" href="modules.html">libraries</a> covering data structures and algorithms
166employed in common robotics research areas.</p>
167<p>It is open source, released under the <a class="reference external" href="license.html">3-clause BSD license</a>.</p>
168</section>
169<section id="get-it">
170<h2>Get it<a class="headerlink" href="#get-it" title="Permalink to this heading"></a></h2>
171<ul class="simple">
172<li><p><a class="reference internal" href="download-mrpt.html#downloadmrpt"><span class="std std-ref">Download MRPT</span></a>: for installing for Linux or Windows.</p></li>
173<li><p><a class="reference internal" href="compiling.html#compiling"><span class="std std-ref">Compiling</span></a>: to build from sources.</p></li>
174</ul>
175</section>
176<section id="where-to-start">
177<h2>Where to start<a class="headerlink" href="#where-to-start" title="Permalink to this heading"></a></h2>
178<ul class="simple">
179<li><p><a class="reference external" href="tutorials.html">Tutorials</a></p></li>
180<li><p>C++ API reference: <a class="reference internal" href="modules.html#modules"><span class="std std-ref">MRPT modules</span></a>.</p></li>
181<li><p>Dozens of examples: <a class="reference internal" href="examples.html#examples"><span class="std std-ref">C++ examples</span></a>.</p></li>
182<li><p>GitHub repository: <a class="reference external" href="https://github.com/MRPT/mrpt">https://github.com/MRPT/mrpt</a></p></li>
183<li><p>Ask questions at the mail list <a class="reference external" href="https://groups.google.com/forum/#!forum/mrpt-users">mrpt-users&#64;googlegroups.com</a> or at <a class="reference external" href="https://stackoverflow.com/search?q=mrpt">stackoverflow</a>  using the tag <cite>mrpt</cite>.</p></li>
184<li><p>Example configuration files for  MRPT applications can be found at:
185<a class="reference external" href="https://github.com/MRPT/mrpt/tree/master/share/mrpt/config_files">MRPT/share/mrpt/config_files</a>.</p></li>
186<li><p>Some sample datasets are stored in:
187<a class="reference external" href="https://github.com/MRPT/mrpt/tree/master/share/mrpt/datasets">MRPT/share/mrpt/datasets</a>.
188A more complete dataset repository is <a class="reference external" href="https://www.mrpt.org/robotics_datasets">available online</a>.</p></li>
189<li><p><a class="reference internal" href="contributing.html#contributing"><span class="std std-ref">Contributing</span></a> your bug fixes, new features, etc.</p></li>
190</ul>
191</section>
192<section id="you-may-also-want-to-see">
193<h2>You may also want to see<a class="headerlink" href="#you-may-also-want-to-see" title="Permalink to this heading"></a></h2>
194<ul class="simple">
195<li><p>The <a class="reference external" href="page_changelog.html">ChangeLog</a> for this version.</p></li>
196<li><p>Performance benchmarks: Extensive performance tests are automated by means of the application <cite>mrpt-performance</cite>, which was moved (2018)
197to <a class="reference external" href="https://github.com/MRPT/mrpt-performance-tests">its own Git repository</a>. The results on different platforms, as well as a comparison between different
198compilers and platforms are published in <a class="reference external" href="https://performance.mrpt.org/">https://performance.mrpt.org/</a></p></li>
199<li><p><a class="reference external" href="porting_mrpt2.html">Porting your code from MRPT 1.x to MRPT 2.x</a></p></li>
200<li><p>MRPT is used in the <a class="reference external" href="https://github.com/MOLAorg/mola/">MOLA modular SLAM framework</a>.</p></li>
201</ul>
202</section>
203<section id="indices-and-tables">
204<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h2>
205<ul class="simple">
206<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
207<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
208</ul>
209</section>
210</section>
211
212
213           </div>
214          </div>
215          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
216        <a href="download-mrpt.html" class="btn btn-neutral float-right" title="Download MRPT" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
217    </div>
218
219  <hr/>
220
221  <div role="contentinfo">
222    <p>&#169; Copyright 2026 MRPT authors.
223      <span class="lastupdated">Last updated on 23:01, Jul 02, 2026.
224      </span></p>
225  </div>
226
227  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
228    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
229    provided by <a href="https://readthedocs.org">Read the Docs</a>.
230   
231
232</footer>
233        </div>
234      </div>
235    </section>
236  </div>
237  
237<script>
238      jQuery(function () {
239          SphinxRtdTheme.Navigation.enable(true);
240      });
241  </script>
241
242 
243<!-- Default Statcounter code for MRPT reference -->
244<script type="text/javascript">
245var sc_project=2835288;
246var sc_invisible=1;
247var sc_security="862cd600";
248</script>
vendor: 1 bytes, line 248
248
249<script type="text/javascript"
250src="https://www.statcounter.com/counter/counter.js"
251async></script>
251
252<noscript><div class="statcounter"><a title="Web Analytics"
253href="https://statcounter.com/" target="_blank"><img
254class="statcounter"
255src="https://c.statcounter.com/2835288/0/862cd600/1/"
256alt="Web Analytics"></a></div></noscript>
257<!-- End of Statcounter Code -->
258
259
260</body>
261</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.