2026-08-06 22:56:24 +00:00
<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
< meta http-equiv = "X-UA-Compatible" content = "IE=11" />
< meta name = "generator" content = "Doxygen 1.9.8" />
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
< title > RTAB-Map: rtabmap::StereoBM Class Reference</ title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "jquery.js" ></ script >
< script type = "text/javascript" src = "dynsections.js" ></ script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "resize.js" ></ script >
< script type = "text/javascript" src = "navtreedata.js" ></ script >
< script type = "text/javascript" src = "navtree.js" ></ script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "search/searchdata.js" ></ script >
< script type = "text/javascript" src = "search/search.js" ></ script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" />
< link href = "doxygen-awesome.css" rel = "stylesheet" type = "text/css" />
< link href = "custom.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" > window . RTABMAP_DOC_ROOT = "" ;</ script >
< script type = "text/javascript" src = "../versions.js" ></ script >
< script type = "text/javascript" src = "version-switcher.js" ></ script >
< script type = "text/javascript" src = "doxygen-awesome-darkmode-toggle.js" ></ script >
< script type = "text/javascript" > DoxygenAwesomeDarkModeToggle . init ();</ script >
</ head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
2026-08-23 20:27:42 +00:00
< div id = "projectname" > RTAB-Map< span id = "projectnumber" >   0.23.11</ span >
2026-08-06 22:56:24 +00:00
</ div >
< div id = "projectbrief" > Real-Time Appearance-Based Mapping</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox ( "searchBox" , "search/" , '.html' );
/* @license-end */
</ script >
< script type = "text/javascript" src = "menudata.js" ></ script >
< script type = "text/javascript" src = "menu.js" ></ script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$ ( function () {
initMenu ( '' , true , false , 'search.php' , 'Search' );
$ ( document ). ready ( function () { init_search (); });
});
/* @license-end */
</ script >
< div id = "main-nav" ></ div >
</ div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" ></ div >
</ div >
</ div >
< div id = "splitbar" style = "-moz-user-select:none;"
class = "ui-resizable-handle" >
</ div >
</ div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$ ( document ). ready ( function (){ initNavTree ( 'classrtabmap_1_1StereoBM.html' , '' ); initResizable (); });
/* @license-end */
</ script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover = "return searchBox.OnSearchSelectShow()"
onmouseout = "return searchBox.OnSearchSelectHide()"
onkeydown = "return searchBox.OnSearchSelectKey(event)" >
</ div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" ></ div >
< div class = "SRStatus" id = "Loading" > Loading...</ div >
< div class = "SRStatus" id = "Searching" > Searching...</ div >
< div class = "SRStatus" id = "NoMatches" > No Matches</ div >
</ div >
</ div >
</ div >
</ div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "classrtabmap_1_1StereoBM-members.html" > List of all members</ a > </ div >
< div class = "headertitle" >< div class = "title" > rtabmap::StereoBM Class Reference</ div ></ div >
</ div > <!--header-->
< div class = "contents" >
< p > Block Matching algorithm for dense stereo matching.
< a href = "classrtabmap_1_1StereoBM.html#details" > More...</ a ></ p >
< p >< code > #include < < a class = "el" href = "StereoBM_8h_source.html" > StereoBM.h</ a > > </ code ></ p >
< div class = "dynheader" >
Inheritance diagram for rtabmap::StereoBM:</ div >
< div class = "dyncontent" >
< div class = "center" >< img src = "classrtabmap_1_1StereoBM__inherit__graph.png" border = "0" usemap = "#artabmap_1_1StereoBM_inherit__map" alt = "Inheritance graph" /></ div >
< map name = "artabmap_1_1StereoBM_inherit__map" id = "artabmap_1_1StereoBM_inherit__map" >
< area shape = "rect" title = "Block Matching algorithm for dense stereo matching." alt = "" coords = "15,79,163,104" />
< area shape = "rect" href = "classrtabmap_1_1StereoDense.html" title = "Abstract base class for dense stereo matching algorithms." alt = "" coords = "5,5,173,31" />
< area shape = "poly" title = " " alt = "" coords = "92,44,92,79,87,79,87,44" />
</ map >
< center >< span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend</ a > ]</ span ></ center ></ div >
< div class = "dynheader" >
Collaboration diagram for rtabmap::StereoBM:</ div >
< div class = "dyncontent" >
< div class = "center" >< img src = "classrtabmap_1_1StereoBM__coll__graph.png" border = "0" usemap = "#artabmap_1_1StereoBM_coll__map" alt = "Collaboration graph" /></ div >
< map name = "artabmap_1_1StereoBM_coll__map" id = "artabmap_1_1StereoBM_coll__map" >
< area shape = "rect" title = "Block Matching algorithm for dense stereo matching." alt = "" coords = "15,79,163,104" />
< area shape = "rect" href = "classrtabmap_1_1StereoDense.html" title = "Abstract base class for dense stereo matching algorithms." alt = "" coords = "5,5,173,31" />
< area shape = "poly" title = " " alt = "" coords = "92,44,92,79,87,79,87,44" />
</ map >
< center >< span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend</ a > ]</ span ></ center ></ div >
< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-methods" name = "pub-methods" ></ a >
Public Member Functions</ h2 ></ td ></ tr >
< tr class = "memitem:a33ff25f4afacce93201f509b78e5ca6f" id = "r_a33ff25f4afacce93201f509b78e5ca6f" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoBM.html#a33ff25f4afacce93201f509b78e5ca6f" > StereoBM</ a > (int blockSize, int numDisparities)</ td ></ tr >
< tr class = "memdesc:a33ff25f4afacce93201f509b78e5ca6f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Constructor with explicit block size and number of disparities. < br /></ td ></ tr >
< tr class = "separator:a33ff25f4afacce93201f509b78e5ca6f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a74970c7517eec90828dd03510c3e3db0" id = "r_a74970c7517eec90828dd03510c3e3db0" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoBM.html#a74970c7517eec90828dd03510c3e3db0" > StereoBM</ a > (const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > & parameters=< a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > ())</ td ></ tr >
< tr class = "memdesc:a74970c7517eec90828dd03510c3e3db0" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Constructor with parameters map. < br /></ td ></ tr >
< tr class = "separator:a74970c7517eec90828dd03510c3e3db0" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a6d5e4ac8698669323dff297c01f7ee4b" id = "r_a6d5e4ac8698669323dff297c01f7ee4b" >< td class = "memItemLeft" align = "right" valign = "top" > virtual  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoBM.html#a6d5e4ac8698669323dff297c01f7ee4b" > ~StereoBM</ a > ()</ td ></ tr >
< tr class = "memdesc:a6d5e4ac8698669323dff297c01f7ee4b" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Virtual destructor. < br /></ td ></ tr >
< tr class = "separator:a6d5e4ac8698669323dff297c01f7ee4b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ab3960fcf495a6dcacfab58ed144b4cc7" id = "r_ab3960fcf495a6dcacfab58ed144b4cc7" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoBM.html#ab3960fcf495a6dcacfab58ed144b4cc7" > parseParameters</ a > (const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > & parameters)</ td ></ tr >
< tr class = "memdesc:ab3960fcf495a6dcacfab58ed144b4cc7" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Parse parameters from a parameters map. < br /></ td ></ tr >
< tr class = "separator:ab3960fcf495a6dcacfab58ed144b4cc7" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a94b6d71050cf4b784f87853175c57b00" id = "r_a94b6d71050cf4b784f87853175c57b00" >< td class = "memItemLeft" align = "right" valign = "top" > virtual cv::Mat  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoBM.html#a94b6d71050cf4b784f87853175c57b00" > computeDisparity</ a > (const cv::Mat & leftImage, const cv::Mat & rightImage) const</ td ></ tr >
< tr class = "memdesc:a94b6d71050cf4b784f87853175c57b00" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Compute disparity map from stereo image pair. < br /></ td ></ tr >
< tr class = "separator:a94b6d71050cf4b784f87853175c57b00" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_classrtabmap_1_1StereoDense" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_classrtabmap_1_1StereoDense')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "classrtabmap_1_1StereoDense.html" > rtabmap::StereoDense</ a ></ td ></ tr >
< tr class = "memitem:a5c720eb11114c19540d30886cb0ba1e6 inherit pub_methods_classrtabmap_1_1StereoDense" id = "r_a5c720eb11114c19540d30886cb0ba1e6" >< td class = "memItemLeft" align = "right" valign = "top" > virtual  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoDense.html#a5c720eb11114c19540d30886cb0ba1e6" > ~StereoDense</ a > ()</ td ></ tr >
< tr class = "memdesc:a5c720eb11114c19540d30886cb0ba1e6 inherit pub_methods_classrtabmap_1_1StereoDense" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Virtual destructor. < br /></ td ></ tr >
< tr class = "separator:a5c720eb11114c19540d30886cb0ba1e6 inherit pub_methods_classrtabmap_1_1StereoDense" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "inherited" name = "inherited" ></ a >
Additional Inherited Members</ h2 ></ td ></ tr >
< tr class = "inherit_header pub_types_classrtabmap_1_1StereoDense" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_types_classrtabmap_1_1StereoDense')" >< img src = "closed.png" alt = "-" />   Public Types inherited from < a class = "el" href = "classrtabmap_1_1StereoDense.html" > rtabmap::StereoDense</ a ></ td ></ tr >
< tr class = "memitem:a54329152938c4ca1f259dcb8fa7d8803 inherit pub_types_classrtabmap_1_1StereoDense" id = "r_a54329152938c4ca1f259dcb8fa7d8803" >< td class = "memItemLeft" align = "right" valign = "top" > enum   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoDense.html#a54329152938c4ca1f259dcb8fa7d8803" > Type</ a > { < a class = "el" href = "classrtabmap_1_1StereoDense.html#a54329152938c4ca1f259dcb8fa7d8803a393267c04896dd353dc66ade56c8d5f1" > kTypeBM</ a > = 0
, < a class = "el" href = "classrtabmap_1_1StereoDense.html#a54329152938c4ca1f259dcb8fa7d8803abf3465f1ebb12576596dc4b605c1ffae" > kTypeSGBM</ a > = 1
}</ td ></ tr >
< tr class = "memdesc:a54329152938c4ca1f259dcb8fa7d8803" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Enumeration of available stereo matching algorithm types. < a href = "classrtabmap_1_1StereoDense.html#a54329152938c4ca1f259dcb8fa7d8803" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a54329152938c4ca1f259dcb8fa7d8803 inherit pub_types_classrtabmap_1_1StereoDense" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_static_methods_classrtabmap_1_1StereoDense" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_static_methods_classrtabmap_1_1StereoDense')" >< img src = "closed.png" alt = "-" />   Static Public Member Functions inherited from < a class = "el" href = "classrtabmap_1_1StereoDense.html" > rtabmap::StereoDense</ a ></ td ></ tr >
< tr class = "memitem:ad2a4e50429b17c2cb1938e9d922ba7ce inherit pub_static_methods_classrtabmap_1_1StereoDense" id = "r_ad2a4e50429b17c2cb1938e9d922ba7ce" >< td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "classrtabmap_1_1StereoDense.html" > StereoDense</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoDense.html#ad2a4e50429b17c2cb1938e9d922ba7ce" > create</ a > (const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > & parameters)</ td ></ tr >
< tr class = "memdesc:ad2a4e50429b17c2cb1938e9d922ba7ce inherit pub_static_methods_classrtabmap_1_1StereoDense" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Factory method to create a < a class = "el" href = "classrtabmap_1_1StereoDense.html" title = "Abstract base class for dense stereo matching algorithms." > StereoDense</ a > instance from parameters. < br /></ td ></ tr >
< tr class = "separator:ad2a4e50429b17c2cb1938e9d922ba7ce inherit pub_static_methods_classrtabmap_1_1StereoDense" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae52002299f7e443a8e9cdc33effae37c inherit pub_static_methods_classrtabmap_1_1StereoDense" id = "r_ae52002299f7e443a8e9cdc33effae37c" >< td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "classrtabmap_1_1StereoDense.html" > StereoDense</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoDense.html#ae52002299f7e443a8e9cdc33effae37c" > create</ a > (< a class = "el" href = "classrtabmap_1_1StereoDense.html#a54329152938c4ca1f259dcb8fa7d8803" > StereoDense::Type</ a > type, const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > & parameters=< a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > ())</ td ></ tr >
< tr class = "memdesc:ae52002299f7e443a8e9cdc33effae37c inherit pub_static_methods_classrtabmap_1_1StereoDense" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Factory method to create a < a class = "el" href = "classrtabmap_1_1StereoDense.html" title = "Abstract base class for dense stereo matching algorithms." > StereoDense</ a > instance of a specific type. < br /></ td ></ tr >
< tr class = "separator:ae52002299f7e443a8e9cdc33effae37c inherit pub_static_methods_classrtabmap_1_1StereoDense" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pro_methods_classrtabmap_1_1StereoDense" >< td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_classrtabmap_1_1StereoDense')" >< img src = "closed.png" alt = "-" />   Protected Member Functions inherited from < a class = "el" href = "classrtabmap_1_1StereoDense.html" > rtabmap::StereoDense</ a ></ td ></ tr >
< tr class = "memitem:a57f0c431678a2c9db1b5f7dd46cbf49f inherit pro_methods_classrtabmap_1_1StereoDense" id = "r_a57f0c431678a2c9db1b5f7dd46cbf49f" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1StereoDense.html#a57f0c431678a2c9db1b5f7dd46cbf49f" > StereoDense</ a > (const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > & parameters=< a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > ())</ td ></ tr >
< tr class = "memdesc:a57f0c431678a2c9db1b5f7dd46cbf49f inherit pro_methods_classrtabmap_1_1StereoDense" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Protected constructor. < br /></ td ></ tr >
< tr class = "separator:a57f0c431678a2c9db1b5f7dd46cbf49f inherit pro_methods_classrtabmap_1_1StereoDense" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Block Matching algorithm for dense stereo matching. </ p >
< p > This class implements the Block Matching (BM) algorithm for computing disparity maps from stereo image pairs.</ p >
< dl class = "section note" >< dt > Note</ dt >< dd > This class wraps OpenCV's cv::StereoBM implementation. </ dd ></ dl >
< dl class = "section see" >< dt > See also</ dt >< dd >< a class = "el" href = "classrtabmap_1_1StereoSGBM.html" title = "Semi-Global Block Matching algorithm for dense stereo matching." > StereoSGBM</ a > for a more accurate but slower alternative </ dd ></ dl >
< p class = "definition" > Definition at line < a class = "el" href = "StereoBM_8h_source.html#l00047" > 47</ a > of file < a class = "el" href = "StereoBM_8h_source.html" > StereoBM.h</ a > .</ p >
</ div >< h2 class = "groupheader" > Constructor & Destructor Documentation</ h2 >
< a id = "a33ff25f4afacce93201f509b78e5ca6f" name = "a33ff25f4afacce93201f509b78e5ca6f" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a33ff25f4afacce93201f509b78e5ca6f" > ◆  </ a ></ span > StereoBM() < span class = "overload" > [1/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > rtabmap::StereoBM::StereoBM </ td >
< td > (</ td >
< td class = "paramtype" > int  </ td >
< td class = "paramname" >< em > blockSize</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > int  </ td >
< td class = "paramname" >< em > numDisparities</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Constructor with explicit block size and number of disparities. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > blockSize</ td >< td > Size of the block window for matching (must be odd, typically 5-21) </ td ></ tr >
< tr >< td class = "paramname" > numDisparities</ td >< td > Number of disparity levels to search (must be divisible by 16) </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a74970c7517eec90828dd03510c3e3db0" name = "a74970c7517eec90828dd03510c3e3db0" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a74970c7517eec90828dd03510c3e3db0" > ◆  </ a ></ span > StereoBM() < span class = "overload" > [2/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > rtabmap::StereoBM::StereoBM </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > &  </ td >
< td class = "paramname" >< em > parameters</ em > = < code >< a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > ()</ code ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Constructor with parameters map. </ p >
< p > Creates a < a class = "el" href = "classrtabmap_1_1StereoBM.html" title = "Block Matching algorithm for dense stereo matching." > StereoBM</ a > instance and initializes it from the provided parameters map.</ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > parameters</ td >< td >< a class = "el" href = "classrtabmap_1_1Parameters.html" > Parameters</ a > map containing configuration values </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a6d5e4ac8698669323dff297c01f7ee4b" name = "a6d5e4ac8698669323dff297c01f7ee4b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a6d5e4ac8698669323dff297c01f7ee4b" > ◆  </ a ></ span > ~StereoBM()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual rtabmap::StereoBM::~StereoBM </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > inline</ span >< span class = "mlabel" > virtual</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Virtual destructor. </ p >
< p class = "definition" > Definition at line < a class = "el" href = "StereoBM_8h_source.html#l00069" > 69</ a > of file < a class = "el" href = "StereoBM_8h_source.html" > StereoBM.h</ a > .</ p >
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
< a id = "ab3960fcf495a6dcacfab58ed144b4cc7" name = "ab3960fcf495a6dcacfab58ed144b4cc7" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ab3960fcf495a6dcacfab58ed144b4cc7" > ◆  </ a ></ span > parseParameters()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void rtabmap::StereoBM::parseParameters </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55" > ParametersMap</ a > &  </ td >
< td class = "paramname" >< em > parameters</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > virtual</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Parse parameters from a parameters map. </ p >
< p > Updates the algorithm's configuration based on the provided parameters map. Supported parameters:</ p >< ul >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#a19264fbd2a0f9441c10cc06ffe4023b8" title = "Key of parameter StereoBM/BlockSize : "See cv::StereoBM" Default value: 15 ( int )." > Parameters::kStereoBMBlockSize()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#a619cb0a6210079348902c069cc1c614a" title = "Key of parameter StereoBM/MinDisparity : "See cv::StereoBM" Default value: 0 ( int )." > Parameters::kStereoBMMinDisparity()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#ae4d531d7472f534c00fb8b5aae5fc723" title = "Key of parameter StereoBM/NumDisparities : "See cv::StereoBM" Default value: 128 ( int )." > Parameters::kStereoBMNumDisparities()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#a5c8d75ee0c4f9a4c8eb033e9e47f5fdc" title = "Key of parameter StereoBM/PreFilterSize : "See cv::StereoBM" Default value: 9 ( int )." > Parameters::kStereoBMPreFilterSize()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#abcf20058345e9e63f2a099348a27447c" title = "Key of parameter StereoBM/PreFilterCap : "See cv::StereoBM" Default value: 31 ( int )." > Parameters::kStereoBMPreFilterCap()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#aecd9a6f9ae9f1982a24ccfae3173d884" title = "Key of parameter StereoBM/UniquenessRatio : "See cv::StereoBM" Default value: 15 ( int )." > Parameters::kStereoBMUniquenessRatio()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#a3b18299607c2d3e13b4193eab70981da" title = "Key of parameter StereoBM/TextureThreshold : "See cv::StereoBM" Default value: 10 ( int )." > Parameters::kStereoBMTextureThreshold()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#af47f8797f5a9b3827b9e4115ca7d3fd2" title = "Key of parameter StereoBM/SpeckleWindowSize : "See cv::StereoBM" Default value: 100 ( int )." > Parameters::kStereoBMSpeckleWindowSize()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#a42ec227016e22c6b05c8f0a5f6bdc4e9" title = "Key of parameter StereoBM/SpeckleRange : "See cv::StereoBM" Default value: 4 ( int )." > Parameters::kStereoBMSpeckleRange()</ a ></ li >
< li >< a class = "el" href = "classrtabmap_1_1Parameters.html#adfa753955fde235a1368dd679b75ee56" title = "Key of parameter StereoBM/Disp12MaxDiff : "See cv::StereoBM" Default value: -1 ( int )." > Parameters::kStereoBMDisp12MaxDiff()</ a ></ li >
</ ul >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > parameters</ td >< td >< a class = "el" href = "classrtabmap_1_1Parameters.html" > Parameters</ a > map containing configuration values </ td ></ tr >
</ table >
</ dd >
</ dl >
< p > Reimplemented from < a class = "el" href = "classrtabmap_1_1StereoDense.html#ac2f693ca52897501450f2bda985c5cf5" > rtabmap::StereoDense</ a > .</ p >
</ div >
</ div >
< a id = "a94b6d71050cf4b784f87853175c57b00" name = "a94b6d71050cf4b784f87853175c57b00" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a94b6d71050cf4b784f87853175c57b00" > ◆  </ a ></ span > computeDisparity()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual cv::Mat rtabmap::StereoBM::computeDisparity </ td >
< td > (</ td >
< td class = "paramtype" > const cv::Mat &  </ td >
< td class = "paramname" >< em > leftImage</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const cv::Mat &  </ td >
< td class = "paramname" >< em > rightImage</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td > const</ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > virtual</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Compute disparity map from stereo image pair. </ p >
< p > Computes a disparity map using the Block Matching algorithm. The images must have the same size and be either grayscale (CV_8UC1) or color (CV_8UC3). Color images are automatically converted to grayscale.</ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > leftImage</ td >< td > Left stereo image (CV_8UC1 or CV_8UC3) </ td ></ tr >
< tr >< td class = "paramname" > rightImage</ td >< td > Right stereo image (CV_8UC1 or CV_8UC3), must have same size as leftImage </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > Disparity map as a 16-bit signed integer image (CV_16SC1) </ dd ></ dl >
< dl class = "section note" >< dt > Note</ dt >< dd > The disparity values are stored as fixed-point numbers with 4 fractional bits. To get the actual disparity, divide by 16. </ dd ></ dl >
< p > Implements < a class = "el" href = "classrtabmap_1_1StereoDense.html#ac394d1dad3fa899f310e4c3eb3e428c4" > rtabmap::StereoDense</ a > .</ p >
</ div >
</ div >
< hr /> The documentation for this class was generated from the following file:< ul >
< li > corelib/include/rtabmap/core/stereo/< a class = "el" href = "StereoBM_8h_source.html" > StereoBM.h</ a ></ li >
</ ul >
</ div > <!-- contents -->
</ div > <!-- doc-content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" >< a class = "el" href = "namespacertabmap.html" > rtabmap</ a ></ li >< li class = "navelem" >< a class = "el" href = "classrtabmap_1_1StereoBM.html" > StereoBM</ a ></ li >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" >< img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" /></ a > 1.9.8 </ li >
</ ul >
</ div >
</ body >
</ html >
