mainPage_doc.h Source File

Go to the documentation of this file.
 /* +---------------------------------------------------------------------------+
    |                 The Mobile Robot Programming Toolkit (MRPT)               |
    |                                                                           |
    |                          http://www.mrpt.org/                             |
    |                                                                           |
    | Copyright (c) 2005-2017, MAPIR group, University of Malaga                |
    | All rights reserved.                                                      |
    |                                                                           |
    | Redistribution and use in source and binary forms, with or without        |
    | modification, are permitted provided that the following conditions are    |
    | met:                                                                      |
    |    * Redistributions of source code must retain the above copyright       |
    |      notice, this list of conditions and the following disclaimer.        |
    |    * Redistributions in binary form must reproduce the above copyright    |
    |      notice, this list of conditions and the following disclaimer in the  |
    |      documentation and/or other materials provided with the distribution. |
    |    * Neither the name of the copyright holders nor the                    |
    |      names of its contributors may be used to endorse or promote products |
    |      derived from this software without specific prior written permission.|
    |                                                                           |
    | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       |
    | 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
    | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR|
    | PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE |
    | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL|
    | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR|
    |  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)       |
    | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       |
    | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  |
    | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           |
    | POSSIBILITY OF SUCH DAMAGE.                                               |
    +---------------------------------------------------------------------------+ */
 
 
 /** \mainpage The Mobile Robot Programming Toolkit (MRPT)
  *
 
 <div align=center >
         <b>Version: 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100</b> <br>
 </div>
 <hr>
 
 <br>
 
 <a name=intro>
 <h2>Introduction</h2>
 
 This is the home of the MRPT C++ library documentation generated by Doxygen. 
 See the <a href=changelog.html > CHANGELOG </a> for this release.
 </p>
 
 You can browse the complete list of classes <a href=annotated.html >here</a>, or use the tabs on the top of this page for looking for a specific namespace, 
 hierarchy of classes, etc.
 
 This reference documentation is complementary to the <a href=http://www.mrpt.org/The_MRPT_book/ >MRPT book</a> available for download at the main web site.
 
 
 <br>
 <a name=libs>
 <h2>Libraries / Modules</h2>
 
 Click on a library name to see a summary of its contents, 
 or <b>explore the</b> <a href=modules.html ><b>complete list</b></a> <b>of modules</b>.
 Mark meaning:
 - (*): experimental libraries.
 - (.h): Header-only libraries. Don't require any .so/.dll file, just adding #include<>'s to user code.
 
 <div align=center >
 \dot
 digraph MRPT_LIBS {
 
         node [shape=box,style=filled, fillcolor="#D0D0D0"];
 
         base       [label="mrpt-base",URL="group__mrpt__base__grp.html"];
         comms      [label="mrpt-comms",URL="group__mrpt__comms__grp.html"];
         graphs     [label="mrpt-graphs",URL="group__mrpt__graphs__grp.html"];
         bayes      [label="mrpt-bayes (.h)",URL="group__mrpt__bayes__grp.html"];
         opengl     [label="mrpt-opengl", URL="group__mrpt__opengl__grp.html"];
         gui        [label="mrpt-gui",URL="group__mrpt__gui__grp.html"];
         obs        [label="mrpt-obs",URL="group__mrpt__obs__grp.html"];
         hwdrivers  [label="mrpt-hwdrivers",URL="group__mrpt__hwdrivers__grp.html"];
         topography [label="mrpt-topography",URL="group__mrpt__topography__grp.html"];
         maps       [label="mrpt-maps",URL="group__mrpt__maps__grp.html"];
         vision     [label="mrpt-vision",URL="group__mrpt__vision__grp.html"];
         tfest      [label="mrpt-tfest",URL="group__mrpt__tfest__grp.html"];
 
         slam       [label="mrpt-slam",URL="group__mrpt__slam__grp.html"];
         graphslam  [label="mrpt-graphslam",URL="group__mrpt__graphslam__grp.html"];
 
         hmtslam    [label="mrpt-hmtslam",URL="group__mrpt__hmtslam__grp.html"];
         nav        [label="mrpt-nav",URL="group__mrpt__nav__grp.html"];
 
         detectors  [label="mrpt-detectors",URL="group__mrpt__detectors__grp.html"];
 
         kinematics [label="mrpt-kinematics",URL="group__mrpt__kinematics__grp.html"];
 
         pbmap      [label="mrpt-pbmap",URL="group__mrpt__pbmap__grp.html"];
 
         pbmap -> graphs;
 
         kinematics -> opengl;
 
         graphs -> base;
         tfest -> base;
         comms -> base;
 
         bayes -> base;
 
         opengl -> base;
 
         obs -> opengl;
 
         gui -> opengl;
 
         hwdrivers -> gui;
         hwdrivers -> maps;
         hwdrivers -> comms;
 
         topography -> obs;
         topography -> tfest;
 
         vision -> obs;
 
         maps -> obs;
         maps -> graphs;
 
         slam -> maps;
         slam -> vision;
         slam -> tfest;
         slam -> bayes;
         slam -> graphs;
 
         graphslam -> slam;
         graphslam -> gui;
 
         detectors -> vision;
         detectors -> maps;
         detectors -> gui;
 
         hmtslam -> slam;
         hmtslam -> graphslam;
 
         nav -> maps;
         nav -> graphs;
         nav -> kinematics;
 }
 
 \enddot
 </div>
 
 Read also <a href=http://www.mrpt.org/Libraries_tree_layout >the guide</a> to write new MRPT libraries.
 
 <br><a name=dependencies>
 <h2>Dependencies</h2>
 
 Check out <a href=dependencies.html >this page</a> to find out what are needed for each of the MRPT build dependencies (opencv, wxWidgets,...) 
 to decide if you need them for your applications.
 
 
 
 <br><a name=perf>
 <h2>Performance benchmarks</h2>
 
 Extensive performance tests are automated by means of the application mrpt-performance.  
 To see the results on different platforms, as well as a comparison between different 
 compilers and platforms, see the <a href=perf-html/index.html> performance page</a>.
 
 
 */
 
 
 