Update documentation (latest) aa95581cd2

This commit is contained in:
github-actions[bot]
2026-10-04 02:56:16 +00:00
parent 1d65b42577
commit fbf0f356c5
737 changed files with 3136 additions and 2772 deletions
+78 -44
View File
@@ -33,7 +33,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.23.13</span>
<div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.24.0</span>
</div>
<div id="projectbrief">Real-Time Appearance-Based Mapping</div>
</td>
@@ -144,64 +144,98 @@ $(document).ready(function(){initNavTree('Compression_8h_source.html',''); initR
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacertabmap.html">rtabmap</a> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="};">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html"> 67</a></span><span class="keyword">class </span>RTABMAP_CORE_EXPORT <a class="code hl_class" href="classrtabmap_1_1CompressionThread.html">CompressionThread</a> : <span class="keyword">public</span> <a class="code hl_class" href="classUThread.html">UThread</a></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>{</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a6bdec4c44e47774291bc9f98b3b5c146"> 75</a></span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a6bdec4c44e47774291bc9f98b3b5c146">CompressionThread</a>(<span class="keyword">const</span> cv::Mat &amp; mat, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a8cfe0e3d632c888c143b4e7902145fde"> 81</a></span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a8cfe0e3d632c888c143b4e7902145fde">CompressionThread</a>(<span class="keyword">const</span> cv::Mat &amp; bytes, <span class="keywordtype">bool</span> isImage);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d"> 83</a></span> <span class="keyword">const</span> cv::Mat &amp; <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d">getCompressedData</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> compressedData_;}</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4"> 85</a></span> cv::Mat &amp; <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4">getUncompressedData</a>() {<span class="keywordflow">return</span> uncompressedData_;}</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a4948c2a9c84ee4e15699f08c2d4bac22"> 87</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a4948c2a9c84ee4e15699f08c2d4bac22">mainLoop</a>();</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> cv::Mat compressedData_;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> cv::Mat uncompressedData_;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> std::string format_;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">bool</span> image_;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">bool</span> compressMode_;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span>};</div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="};">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html"> 68</a></span><span class="keyword">class </span>RTABMAP_CORE_EXPORT <a class="code hl_class" href="classrtabmap_1_1CompressionThread.html">CompressionThread</a> : <span class="keyword">public</span> <a class="code hl_class" href="classUThread.html">UThread</a></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a6bdec4c44e47774291bc9f98b3b5c146"> 76</a></span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a6bdec4c44e47774291bc9f98b3b5c146">CompressionThread</a>(<span class="keyword">const</span> cv::Mat &amp; mat, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a8cfe0e3d632c888c143b4e7902145fde"> 82</a></span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a8cfe0e3d632c888c143b4e7902145fde">CompressionThread</a>(<span class="keyword">const</span> cv::Mat &amp; bytes, <span class="keywordtype">bool</span> isImage);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d"> 84</a></span> <span class="keyword">const</span> cv::Mat &amp; <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d">getCompressedData</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> compressedData_;}</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4"> 86</a></span> cv::Mat &amp; <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4">getUncompressedData</a>() {<span class="keywordflow">return</span> uncompressedData_;}</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classrtabmap_1_1CompressionThread.html#a4948c2a9c84ee4e15699f08c2d4bac22"> 88</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classrtabmap_1_1CompressionThread.html#a4948c2a9c84ee4e15699f08c2d4bac22">mainLoop</a>();</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> cv::Mat compressedData_;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> cv::Mat uncompressedData_;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> std::string format_;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">bool</span> image_;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">bool</span> compressMode_;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>};</div>
</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a52beb14eea422420c95fd69bdf3ab9dc"> 97</a></span>std::vector&lt;unsigned char&gt; RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a52beb14eea422420c95fd69bdf3ab9dc">compressImage</a>(<span class="keyword">const</span> cv::Mat &amp; image, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;.png&quot;</span>);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="namespacertabmap.html#abd9d5523210562abd9b5dc8fa9dbeb99"> 99</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#abd9d5523210562abd9b5dc8fa9dbeb99">compressImage2</a>(<span class="keyword">const</span> cv::Mat &amp; image, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;.png&quot;</span>);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5"> 102</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">uncompressImage</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="namespacertabmap.html#af56ea8b86f7a873959588d35a7ede187"> 104</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">uncompressImage</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a749adef593d09b887926afb6ebdb5834"> 107</a></span>std::vector&lt;unsigned char&gt; RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a749adef593d09b887926afb6ebdb5834">compressData</a>(<span class="keyword">const</span> cv::Mat &amp; data);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="namespacertabmap.html#aca82ee9efc46461c648c7ab8999e1d5b"> 109</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#aca82ee9efc46461c648c7ab8999e1d5b">compressData2</a>(<span class="keyword">const</span> cv::Mat &amp; data);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9"> 112</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="namespacertabmap.html#aa15a9e946d6571254fc3c808b624e6cd"> 114</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a5b02b6a5cd3c620aff7e76c05f78b20f"> 116</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * bytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> size);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a4f0dfae296aa7029e959d573b286285a"> 119</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a4f0dfae296aa7029e959d573b286285a">compressString</a>(<span class="keyword">const</span> std::string &amp; str);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a811701fc1452e49e82fcab8d4476832f"> 121</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a811701fc1452e49e82fcab8d4476832f">uncompressString</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc"> 127</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="namespacertabmap.html#ab5cb2dcd6db7fe3bbe25d847177582c2"> 129</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a58b406e413250675abbf0ec2956e3de8"> 131</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * bytes, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>} <span class="comment">/* namespace rtabmap */</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#endif </span><span class="comment">/* COMPRESSION_H_ */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment">/*</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"> * Compressed depth image layouts (all values little-endian). They are stable: they are</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> * saved in databases, and rtabmap_ros converts them to and from ROS&#39;s</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * compressed_depth_image_transport messages without decompressing the images.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> *</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * - &quot;.png&quot;: a standard PNG file. 16UC1 depth images are 16 bits grayscale PNGs,</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * 32FC1 depth images (legacy) are 4-channel 8 bits PNGs holding the float bytes.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> * - &quot;.rvl&quot; (16UC1):</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> * [0..7] &quot;DEPTHRVL&quot;</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> * [8..11] uint32 cols</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> * [12..15] uint32 rows</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"> * [16..] RVL data (see RvlCodec)</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"> * - &quot;.png:&lt;maxDepth&gt;:&lt;quantization&gt;&quot; or &quot;.rvl:&lt;maxDepth&gt;:&lt;quantization&gt;&quot; (32FC1):</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> * [0..7] &quot;DEPTHINV&quot;</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * [8..11] float depthQuantA = quantization*(quantization+1)</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> * [12..15] float depthQuantB = 1 - depthQuantA/maxDepth</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> * [16..] the 16UC1 inverse depth image in &quot;.png&quot; or &quot;.rvl&quot; layout above, where</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"> * 0 is invalid and v&gt;0 is the depth depthQuantA/(v-depthQuantB).</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"> */</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="namespacertabmap.html#af79397e4c11daefaf353d14f943ae479"> 118</a></span><span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="namespacertabmap.html#af79397e4c11daefaf353d14f943ae479">kCompressedDepthRvlSignature</a>[8] = {<span class="charliteral">&#39;D&#39;</span>, <span class="charliteral">&#39;E&#39;</span>, <span class="charliteral">&#39;P&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;H&#39;</span>, <span class="charliteral">&#39;R&#39;</span>, <span class="charliteral">&#39;V&#39;</span>, <span class="charliteral">&#39;L&#39;</span>};</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="namespacertabmap.html#aaad2804128bde2d3e29f7e76ef4ccd9d"> 120</a></span><span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="namespacertabmap.html#aaad2804128bde2d3e29f7e76ef4ccd9d">kCompressedDepthRvlHeaderSize</a> = 16;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="namespacertabmap.html#ae70d840d2253bf8e575122336b51ee9b"> 122</a></span><span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="namespacertabmap.html#ae70d840d2253bf8e575122336b51ee9b">kCompressedDepthInvSignature</a>[8] = {<span class="charliteral">&#39;D&#39;</span>, <span class="charliteral">&#39;E&#39;</span>, <span class="charliteral">&#39;P&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;H&#39;</span>, <span class="charliteral">&#39;I&#39;</span>, <span class="charliteral">&#39;N&#39;</span>, <span class="charliteral">&#39;V&#39;</span>};</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a6fe0f42207f43d29b6aa013e1a57fb6c"> 124</a></span><span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="namespacertabmap.html#a6fe0f42207f43d29b6aa013e1a57fb6c">kCompressedDepthInvHeaderSize</a> = 16;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="namespacertabmap.html#ac1d5a5ac072d725e236431b21946dc98"> 138</a></span><span class="keywordtype">bool</span> RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#ac1d5a5ac072d725e236431b21946dc98">parseImageCompressionFormat</a>(<span class="keyword">const</span> std::string &amp; format, std::string &amp; codec, <span class="keywordtype">float</span> &amp; maxDepth, <span class="keywordtype">float</span> &amp; quantization);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a52beb14eea422420c95fd69bdf3ab9dc"> 154</a></span>std::vector&lt;unsigned char&gt; RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a52beb14eea422420c95fd69bdf3ab9dc">compressImage</a>(<span class="keyword">const</span> cv::Mat &amp; image, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;.png&quot;</span>);</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="namespacertabmap.html#abd9d5523210562abd9b5dc8fa9dbeb99"> 156</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#abd9d5523210562abd9b5dc8fa9dbeb99">compressImage2</a>(<span class="keyword">const</span> cv::Mat &amp; image, <span class="keyword">const</span> std::string &amp; format = <span class="stringliteral">&quot;.png&quot;</span>);</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5"> 159</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">uncompressImage</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="namespacertabmap.html#af56ea8b86f7a873959588d35a7ede187"> 161</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">uncompressImage</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="namespacertabmap.html#ab82c2ccce0996793c20ace4b13670711"> 163</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">uncompressImage</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * bytes, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a749adef593d09b887926afb6ebdb5834"> 166</a></span>std::vector&lt;unsigned char&gt; RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a749adef593d09b887926afb6ebdb5834">compressData</a>(<span class="keyword">const</span> cv::Mat &amp; data);</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="namespacertabmap.html#aca82ee9efc46461c648c7ab8999e1d5b"> 168</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#aca82ee9efc46461c648c7ab8999e1d5b">compressData2</a>(<span class="keyword">const</span> cv::Mat &amp; data);</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9"> 171</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="namespacertabmap.html#aa15a9e946d6571254fc3c808b624e6cd"> 173</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a5b02b6a5cd3c620aff7e76c05f78b20f"> 175</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">uncompressData</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * bytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> size);</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a4f0dfae296aa7029e959d573b286285a"> 178</a></span>cv::Mat RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a4f0dfae296aa7029e959d573b286285a">compressString</a>(<span class="keyword">const</span> std::string &amp; str);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a811701fc1452e49e82fcab8d4476832f"> 180</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a811701fc1452e49e82fcab8d4476832f">uncompressString</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc"> 189</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> cv::Mat &amp; bytes);</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"><a class="line" href="namespacertabmap.html#ab5cb2dcd6db7fe3bbe25d847177582c2"> 191</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp; bytes);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="namespacertabmap.html#a58b406e413250675abbf0ec2956e3de8"> 193</a></span>std::string RTABMAP_CORE_EXPORT <a class="code hl_function" href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">compressedDepthFormat</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * bytes, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span>} <span class="comment">/* namespace rtabmap */</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="preprocessor">#endif </span><span class="comment">/* COMPRESSION_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassUThread_html"><div class="ttname"><a href="classUThread.html">UThread</a></div><div class="ttdef"><b>Definition</b> <a href="UThread_8h_source.html#l00086">UThread.h:87</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html">rtabmap::CompressionThread</a></div><div class="ttdoc">Background thread to compress or uncompress images and generic matrices.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00067">Compression.h:68</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html">rtabmap::CompressionThread</a></div><div class="ttdoc">Background thread to compress or uncompress images and generic matrices.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00068">Compression.h:69</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_a4948c2a9c84ee4e15699f08c2d4bac22"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#a4948c2a9c84ee4e15699f08c2d4bac22">rtabmap::CompressionThread::mainLoop</a></div><div class="ttdeci">virtual void mainLoop()</div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_a6908afb16364f91c7d0744decf6c970d"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d">rtabmap::CompressionThread::getCompressedData</a></div><div class="ttdeci">const cv::Mat &amp; getCompressedData() const</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00083">Compression.h:83</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_a6908afb16364f91c7d0744decf6c970d"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#a6908afb16364f91c7d0744decf6c970d">rtabmap::CompressionThread::getCompressedData</a></div><div class="ttdeci">const cv::Mat &amp; getCompressedData() const</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00084">Compression.h:84</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_a6bdec4c44e47774291bc9f98b3b5c146"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#a6bdec4c44e47774291bc9f98b3b5c146">rtabmap::CompressionThread::CompressionThread</a></div><div class="ttdeci">CompressionThread(const cv::Mat &amp;mat, const std::string &amp;format=&quot;&quot;)</div><div class="ttdoc">Constructs a thread in compress mode.</div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_a8cfe0e3d632c888c143b4e7902145fde"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#a8cfe0e3d632c888c143b4e7902145fde">rtabmap::CompressionThread::CompressionThread</a></div><div class="ttdeci">CompressionThread(const cv::Mat &amp;bytes, bool isImage)</div><div class="ttdoc">Constructs a thread in uncompress mode.</div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_aafdc57cad744cbe94b30a8abfe7711a4"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4">rtabmap::CompressionThread::getUncompressedData</a></div><div class="ttdeci">cv::Mat &amp; getUncompressedData()</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00085">Compression.h:85</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1CompressionThread_html_aafdc57cad744cbe94b30a8abfe7711a4"><div class="ttname"><a href="classrtabmap_1_1CompressionThread.html#aafdc57cad744cbe94b30a8abfe7711a4">rtabmap::CompressionThread::getUncompressedData</a></div><div class="ttdeci">cv::Mat &amp; getUncompressedData()</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00086">Compression.h:86</a></div></div>
<div class="ttc" id="anamespacertabmap_html"><div class="ttname"><a href="namespacertabmap.html">rtabmap</a></div><div class="ttdef"><b>Definition</b> <a href="BayesFilter_8h_source.html#l00042">BayesFilter.h:42</a></div></div>
<div class="ttc" id="anamespacertabmap_html_a462f181a147c9f5315f70b0cd89210e5"><div class="ttname"><a href="namespacertabmap.html#a462f181a147c9f5315f70b0cd89210e5">rtabmap::uncompressImage</a></div><div class="ttdeci">cv::Mat RTABMAP_CORE_EXPORT uncompressImage(const cv::Mat &amp;bytes)</div><div class="ttdoc">Decodes compressed image bytes to a @cv::Mat.</div></div>
<div class="ttc" id="anamespacertabmap_html_a4f0dfae296aa7029e959d573b286285a"><div class="ttname"><a href="namespacertabmap.html#a4f0dfae296aa7029e959d573b286285a">rtabmap::compressString</a></div><div class="ttdeci">cv::Mat RTABMAP_CORE_EXPORT compressString(const std::string &amp;str)</div><div class="ttdoc">Compresses a null-terminated string using compressData2().</div></div>
<div class="ttc" id="anamespacertabmap_html_a52beb14eea422420c95fd69bdf3ab9dc"><div class="ttname"><a href="namespacertabmap.html#a52beb14eea422420c95fd69bdf3ab9dc">rtabmap::compressImage</a></div><div class="ttdeci">std::vector&lt; unsigned char &gt; RTABMAP_CORE_EXPORT compressImage(const cv::Mat &amp;image, const std::string &amp;format=&quot;.png&quot;)</div><div class="ttdoc">Encodes image to a byte buffer (OpenCV imencode or RVL for depth).</div></div>
<div class="ttc" id="anamespacertabmap_html_a67c525e80a7187b3106e5fd76155cabc"><div class="ttname"><a href="namespacertabmap.html#a67c525e80a7187b3106e5fd76155cabc">rtabmap::compressedDepthFormat</a></div><div class="ttdeci">std::string RTABMAP_CORE_EXPORT compressedDepthFormat(const cv::Mat &amp;bytes)</div><div class="ttdoc">Detects the compression format of depth image bytes.</div></div>
<div class="ttc" id="anamespacertabmap_html_a696fffaafe542bfb49fc9ab0da2c66b9"><div class="ttname"><a href="namespacertabmap.html#a696fffaafe542bfb49fc9ab0da2c66b9">rtabmap::uncompressData</a></div><div class="ttdeci">cv::Mat RTABMAP_CORE_EXPORT uncompressData(const cv::Mat &amp;bytes)</div><div class="ttdoc">Restores a matrix compressed with compressData() or compressData2().</div></div>
<div class="ttc" id="anamespacertabmap_html_a6fe0f42207f43d29b6aa013e1a57fb6c"><div class="ttname"><a href="namespacertabmap.html#a6fe0f42207f43d29b6aa013e1a57fb6c">rtabmap::kCompressedDepthInvHeaderSize</a></div><div class="ttdeci">const size_t kCompressedDepthInvHeaderSize</div><div class="ttdoc">Size of the inverse depth header: signature, float depthQuantA, float depthQuantB.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00124">Compression.h:124</a></div></div>
<div class="ttc" id="anamespacertabmap_html_a749adef593d09b887926afb6ebdb5834"><div class="ttname"><a href="namespacertabmap.html#a749adef593d09b887926afb6ebdb5834">rtabmap::compressData</a></div><div class="ttdeci">std::vector&lt; unsigned char &gt; RTABMAP_CORE_EXPORT compressData(const cv::Mat &amp;data)</div><div class="ttdoc">Compresses a matrix with zlib; appends rows, cols and type at the end.</div></div>
<div class="ttc" id="anamespacertabmap_html_a811701fc1452e49e82fcab8d4476832f"><div class="ttname"><a href="namespacertabmap.html#a811701fc1452e49e82fcab8d4476832f">rtabmap::uncompressString</a></div><div class="ttdeci">std::string RTABMAP_CORE_EXPORT uncompressString(const cv::Mat &amp;bytes)</div><div class="ttdoc">Decompresses a string produced by compressString().</div></div>
<div class="ttc" id="anamespacertabmap_html_aaad2804128bde2d3e29f7e76ef4ccd9d"><div class="ttname"><a href="namespacertabmap.html#aaad2804128bde2d3e29f7e76ef4ccd9d">rtabmap::kCompressedDepthRvlHeaderSize</a></div><div class="ttdeci">const size_t kCompressedDepthRvlHeaderSize</div><div class="ttdoc">Size of the &quot;.rvl&quot; header: signature, uint32 cols, uint32 rows.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00120">Compression.h:120</a></div></div>
<div class="ttc" id="anamespacertabmap_html_abd9d5523210562abd9b5dc8fa9dbeb99"><div class="ttname"><a href="namespacertabmap.html#abd9d5523210562abd9b5dc8fa9dbeb99">rtabmap::compressImage2</a></div><div class="ttdeci">cv::Mat RTABMAP_CORE_EXPORT compressImage2(const cv::Mat &amp;image, const std::string &amp;format=&quot;.png&quot;)</div><div class="ttdoc">Same as compressImage() but returns a CV_8UC1 row matrix.</div></div>
<div class="ttc" id="anamespacertabmap_html_ac1d5a5ac072d725e236431b21946dc98"><div class="ttname"><a href="namespacertabmap.html#ac1d5a5ac072d725e236431b21946dc98">rtabmap::parseImageCompressionFormat</a></div><div class="ttdeci">bool RTABMAP_CORE_EXPORT parseImageCompressionFormat(const std::string &amp;format, std::string &amp;codec, float &amp;maxDepth, float &amp;quantization)</div><div class="ttdoc">Parses an image compression format &quot;&lt;codec&gt;[:&lt;maxDepth&gt;[:&lt;quantization&gt;]]&quot;.</div></div>
<div class="ttc" id="anamespacertabmap_html_aca82ee9efc46461c648c7ab8999e1d5b"><div class="ttname"><a href="namespacertabmap.html#aca82ee9efc46461c648c7ab8999e1d5b">rtabmap::compressData2</a></div><div class="ttdeci">cv::Mat RTABMAP_CORE_EXPORT compressData2(const cv::Mat &amp;data)</div><div class="ttdoc">Same as compressData() but returns a CV_8UC1 row matrix.</div></div>
<div class="ttc" id="anamespacertabmap_html_ae70d840d2253bf8e575122336b51ee9b"><div class="ttname"><a href="namespacertabmap.html#ae70d840d2253bf8e575122336b51ee9b">rtabmap::kCompressedDepthInvSignature</a></div><div class="ttdeci">const char kCompressedDepthInvSignature[8]</div><div class="ttdoc">Signature of the inverse depth layout (8 bytes, not null-terminated).</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00122">Compression.h:122</a></div></div>
<div class="ttc" id="anamespacertabmap_html_af79397e4c11daefaf353d14f943ae479"><div class="ttname"><a href="namespacertabmap.html#af79397e4c11daefaf353d14f943ae479">rtabmap::kCompressedDepthRvlSignature</a></div><div class="ttdeci">const char kCompressedDepthRvlSignature[8]</div><div class="ttdoc">Signature of the &quot;.rvl&quot; layout (8 bytes, not null-terminated).</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00118">Compression.h:118</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->