ROS-MA...ML2MRPT(1)

✨ ros-map-yaml2mrpt — like, the ROS map → MRPT converter ✨

okay bestie, pull up a chair 🫶 you're looking at ROS-MA...ML2MRPT(1), from the Mobile Robot Programming Toolkit - MRPT family. sit down, we're converting maps 💅

---

🌸 NAME 🌸

ros-map-yaml2mrpt — it takes a ROS map_server .yaml file and turns it into MRPT gridmaps. that's it. that's the whole job. iconic honestly 👑

---

🦋 SYNOPSIS 🦋

ros-map-yaml2mrpt  [--generate-3d] [-q] [-w] [-d <.>] -i <map.yaml> [--]
                   [--version] [-h]

---

🍓 USAGE EXAMPLES 🍓

1. convert a ROS yaml file into an MRPT .gridmap file, right there in the same directory:

ros-map-yaml2mrpt -i map.yaml

2. convert it and also generate a .3Dscene file for quick inspection (so you can peek at it, you nosy lil thing 🙈):

ros-map-yaml2mrpt -i map.png --generate-3d

---

✨ DESCRIPTION ✨

so ros-map-yaml2mrpt is a command-line application — a real one, not a vibe — that converts a yaml file plus an image file (following the ROS1 map_server YAML file format, no cap) into an MRPT .gridmap.gz file. and what even is a .gridmap.gz file, you ask? bestie it's literally just a gz-compressed file containing the serialization of an object of type mrpt::maps::COccupancyGridMap2D. that's the whole tea ☕

USAGE:

ros-map-yaml2mrpt  [--generate-3d] [-q] [-w] [-d <.>] -i <map.yaml> [--]
                   [--version] [-h]

where, and I'm gonna hold your hand through every single one:

• --generate-3d — creates a .3Dscene view of the gridmap, suitable for quick visualization in the SceneViewer3D program. yes, you get to look at it. main character energy ✨
• -q, --quiet — do not print info messages to cout, only errors to cerr. for when you want peace and quiet, we love a silent queen 🤫
• -w, --overwrite — force overwrite the target file without prompting. bold. decisive. no second-guessing 💅
• -d <.>, --output-directory <.> — if provided, output files get written to the specified directory instead of the same directory as the input file (which is the default behavior, fyi). warning bestie: the output directory must exist — it will not be created. it is not a girl who manifests things for you, she is not your mom 😭
• -i <map.yaml>, --input <map.yaml> — (required) input map yaml file (required) (*.yaml). yes it says required twice, it's that serious. you cannot skip this one, periodt.
• --, --ignore_rest — ignores the rest of the labeled arguments following this flag. it's giving "I'm done listening now" 🙈
• --version — displays version information and exits. a lil flex and then she's gone 👋
• -h, --help — displays usage information and exits. your bestie when you're lost 🫶

---

💀 BUGS 💀

found a bug? please report bugs at https://github.com/MRPT/mrpt/issues — do it, do it for the girls, do it for the robots 🤖💖

---

🌈 SEE ALSO 🌈

the application list and their documentation (iykyk): https://docs.mrpt.org/reference/latest/applications.html

---

👑 AUTHORS 👑

ros-map-yaml2mrpt is part of the Mobile Robot Programming Toolkit (MRPT), and was originally written by Jose Luis Blanco.

this manual page was written by Jose Luis Blanco <joseluisblancoc@gmail.com>. thank you for your service legend 🎀

---

💜 COPYRIGHT 💜

this program is free software; you can redistribute it and/or modify it under the terms of the BSD License.

on Debian GNU/Linux systems, the complete text of the BSD License can be found in /usr/share/common-licenses/BSD. go read it, it's right there, be a good student 📚

---

okay that's the whole page, you made it, I'm so proud of you 🧚✨

this was ROS-MA...ML2MRPT(1), rendered by perl v5.40.1 and dated 2025-03-21 — love that for us, and love that for you, bye bestie 💖🌸🦋