2026-08-02 01:36:11 +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::CameraOpenNI2 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 >
2026-08-02 07:56:38 +00:00
< 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 >
2026-08-02 01:36:11 +00:00
< 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" />
2026-08-02 17:35:14 +00:00
< link href = "doxygen-awesome.css" rel = "stylesheet" type = "text/css" />
< link href = "custom.css" rel = "stylesheet" type = "text/css" />
2026-08-02 01:36:11 +00:00
< 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 >
2026-08-02 17:35:14 +00:00
< script type = "text/javascript" src = "doxygen-awesome-darkmode-toggle.js" ></ script >
< script type = "text/javascript" > DoxygenAwesomeDarkModeToggle . init ();</ script >
2026-08-02 01:36:11 +00:00
</ 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" >
< div id = "projectname" > RTAB-Map< span id = "projectnumber" >   0.23.10</ span >
</ div >
2026-08-02 07:56:38 +00:00
< div id = "projectbrief" > Real-Time Appearance-Based Mapping</ div >
2026-08-02 01:36:11 +00:00
</ 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 >
2026-08-02 07:56:38 +00:00
</ 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_1CameraOpenNI2.html' , '' ); initResizable (); });
/* @license-end */
</ script >
< div id = "doc-content" >
2026-08-02 01:36:11 +00:00
<!-- 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-types" > Public Types</ a > |
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "#pub-static-methods" > Static Public Member Functions</ a > |
< a href = "#pro-methods" > Protected Member Functions</ a > |
< a href = "classrtabmap_1_1CameraOpenNI2-members.html" > List of all members</ a > </ div >
< div class = "headertitle" >< div class = "title" > rtabmap::CameraOpenNI2 Class Reference</ div ></ div >
</ div > <!--header-->
< div class = "contents" >
< div class = "dynheader" >
Inheritance diagram for rtabmap::CameraOpenNI2:</ div >
< div class = "dyncontent" >
< div class = "center" >< img src = "classrtabmap_1_1CameraOpenNI2__inherit__graph.png" border = "0" usemap = "#artabmap_1_1CameraOpenNI2_inherit__map" alt = "Inheritance graph" /></ div >
< map name = "artabmap_1_1CameraOpenNI2_inherit__map" id = "artabmap_1_1CameraOpenNI2_inherit__map" >
< area shape = "rect" title = " " alt = "" coords = "5,152,197,177" />
< area shape = "rect" href = "classrtabmap_1_1Camera.html" title = " " alt = "" coords = "33,79,169,104" />
< area shape = "poly" title = " " alt = "" coords = "104,118,104,152,99,152,99,118" />
< area shape = "rect" href = "classrtabmap_1_1SensorCapture.html" title = "Abstract base class for sensor data capture (cameras, lidars, etc.)" alt = "" coords = "11,5,191,31" />
< area shape = "poly" title = " " alt = "" coords = "104,44,104,79,99,79,99,44" />
</ map >
2026-08-02 07:56:38 +00:00
< center >< span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend</ a > ]</ span ></ center ></ div >
2026-08-02 01:36:11 +00:00
< div class = "dynheader" >
Collaboration diagram for rtabmap::CameraOpenNI2:</ div >
< div class = "dyncontent" >
< div class = "center" >< img src = "classrtabmap_1_1CameraOpenNI2__coll__graph.png" border = "0" usemap = "#artabmap_1_1CameraOpenNI2_coll__map" alt = "Collaboration graph" /></ div >
< map name = "artabmap_1_1CameraOpenNI2_coll__map" id = "artabmap_1_1CameraOpenNI2_coll__map" >
< area shape = "rect" title = " " alt = "" coords = "5,152,197,177" />
< area shape = "rect" href = "classrtabmap_1_1Camera.html" title = " " alt = "" coords = "33,79,169,104" />
< area shape = "poly" title = " " alt = "" coords = "104,118,104,152,99,152,99,118" />
< area shape = "rect" href = "classrtabmap_1_1SensorCapture.html" title = "Abstract base class for sensor data capture (cameras, lidars, etc.)" alt = "" coords = "11,5,191,31" />
< area shape = "poly" title = " " alt = "" coords = "104,44,104,79,99,79,99,44" />
</ map >
2026-08-02 07:56:38 +00:00
< center >< span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend</ a > ]</ span ></ center ></ div >
2026-08-02 01:36:11 +00:00
< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-types" name = "pub-types" ></ a >
Public Types</ h2 ></ td ></ tr >
< tr class = "memitem:add2f5250ec9d897654f31cf286bc692e" id = "r_add2f5250ec9d897654f31cf286bc692e" >< td class = "memItemLeft" align = "right" valign = "top" > enum   </ td >< td class = "memItemRight" valign = "bottom" >< b > Type</ b > { < b > kTypeColorDepth</ b >
, < b > kTypeIRDepth</ b >
, < b > kTypeIR</ b >
}</ td ></ tr >
< tr class = "separator:add2f5250ec9d897654f31cf286bc692e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< 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:a5ee347200eb2dab3e5a6fe512ff73a06" id = "r_a5ee347200eb2dab3e5a6fe512ff73a06" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a5ee347200eb2dab3e5a6fe512ff73a06" name = "a5ee347200eb2dab3e5a6fe512ff73a06" ></ a >
  </ td >< td class = "memItemRight" valign = "bottom" >< b > CameraOpenNI2</ b > (const std::string & deviceId="" , Type type=kTypeColorDepth, float imageRate=0, const < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > & localTransform=< a class = "el" href = "classrtabmap_1_1Transform.html#a8ea4368f2018d751d2733038081d56a2" > Transform::getIdentity</ a > ())</ td ></ tr >
< tr class = "separator:a5ee347200eb2dab3e5a6fe512ff73a06" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0c0da722b985da3595896fcc6bc72c7b" id = "r_a0c0da722b985da3595896fcc6bc72c7b" >< td class = "memItemLeft" align = "right" valign = "top" > virtual bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1CameraOpenNI2.html#a0c0da722b985da3595896fcc6bc72c7b" > init</ a > (const std::string & calibrationFolder=" ." , const std::string & cameraName="" )</ td ></ tr >
< tr class = "memdesc:a0c0da722b985da3595896fcc6bc72c7b" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Initializes the sensor. < br /></ td ></ tr >
< tr class = "separator:a0c0da722b985da3595896fcc6bc72c7b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aed4c35163df8651021190f6dffe66407" id = "r_aed4c35163df8651021190f6dffe66407" >< td class = "memItemLeft" align = "right" valign = "top" > virtual bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1CameraOpenNI2.html#aed4c35163df8651021190f6dffe66407" > isCalibrated</ a > () const</ td ></ tr >
< tr class = "separator:aed4c35163df8651021190f6dffe66407" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a9767b92c3df7b637c75ee351208e3f0b" id = "r_a9767b92c3df7b637c75ee351208e3f0b" >< td class = "memItemLeft" align = "right" valign = "top" > virtual std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1CameraOpenNI2.html#a9767b92c3df7b637c75ee351208e3f0b" > getSerial</ a > () const</ td ></ tr >
< tr class = "memdesc:a9767b92c3df7b637c75ee351208e3f0b" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Returns the sensor's serial number or unique identifier. < br /></ td ></ tr >
< tr class = "separator:a9767b92c3df7b637c75ee351208e3f0b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa34ceaf5b17c88b19187779f47f714d3" id = "r_aa34ceaf5b17c88b19187779f47f714d3" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aa34ceaf5b17c88b19187779f47f714d3" name = "aa34ceaf5b17c88b19187779f47f714d3" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > setAutoWhiteBalance</ b > (bool enabled)</ td ></ tr >
< tr class = "separator:aa34ceaf5b17c88b19187779f47f714d3" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae7e08872a74d90ea59093441eee92ae9" id = "r_ae7e08872a74d90ea59093441eee92ae9" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "ae7e08872a74d90ea59093441eee92ae9" name = "ae7e08872a74d90ea59093441eee92ae9" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > setAutoExposure</ b > (bool enabled)</ td ></ tr >
< tr class = "separator:ae7e08872a74d90ea59093441eee92ae9" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ac79d56b8ff2a841f319724ae40849c6f" id = "r_ac79d56b8ff2a841f319724ae40849c6f" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "ac79d56b8ff2a841f319724ae40849c6f" name = "ac79d56b8ff2a841f319724ae40849c6f" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > setExposure</ b > (int value)</ td ></ tr >
< tr class = "separator:ac79d56b8ff2a841f319724ae40849c6f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ab30fa7cd92ea6e2ed5f37e455d4b68d8" id = "r_ab30fa7cd92ea6e2ed5f37e455d4b68d8" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "ab30fa7cd92ea6e2ed5f37e455d4b68d8" name = "ab30fa7cd92ea6e2ed5f37e455d4b68d8" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > setGain</ b > (int value)</ td ></ tr >
< tr class = "separator:ab30fa7cd92ea6e2ed5f37e455d4b68d8" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8652368cd56c210a396ee73e16e97f2d" id = "r_a8652368cd56c210a396ee73e16e97f2d" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a8652368cd56c210a396ee73e16e97f2d" name = "a8652368cd56c210a396ee73e16e97f2d" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > setMirroring</ b > (bool enabled)</ td ></ tr >
< tr class = "separator:a8652368cd56c210a396ee73e16e97f2d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aaf84a7ead758abba8f189fbe8334bc7a" id = "r_aaf84a7ead758abba8f189fbe8334bc7a" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aaf84a7ead758abba8f189fbe8334bc7a" name = "aaf84a7ead758abba8f189fbe8334bc7a" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > setOpenNI2StampsAndIDsUsed</ b > (bool used)</ td ></ tr >
< tr class = "separator:aaf84a7ead758abba8f189fbe8334bc7a" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a742ae5278e9259b548cc09e3e06a64d0" id = "r_a742ae5278e9259b548cc09e3e06a64d0" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a742ae5278e9259b548cc09e3e06a64d0" name = "a742ae5278e9259b548cc09e3e06a64d0" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > setIRDepthShift</ b > (int horizontal, int vertical)</ td ></ tr >
< tr class = "separator:a742ae5278e9259b548cc09e3e06a64d0" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a093d169bfd610eb2d9b2743fa2742c9b" id = "r_a093d169bfd610eb2d9b2743fa2742c9b" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a093d169bfd610eb2d9b2743fa2742c9b" name = "a093d169bfd610eb2d9b2743fa2742c9b" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > setDepthDecimation</ b > (int decimation)</ td ></ tr >
< tr class = "separator:a093d169bfd610eb2d9b2743fa2742c9b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_classrtabmap_1_1Camera" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_classrtabmap_1_1Camera')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "classrtabmap_1_1Camera.html" > rtabmap::Camera</ a ></ td ></ tr >
< tr class = "memitem:ae43544cc24470a1d42efcb5ec959b63c inherit pub_methods_classrtabmap_1_1Camera" id = "r_ae43544cc24470a1d42efcb5ec959b63c" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "classrtabmap_1_1SensorData.html" > SensorData</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1Camera.html#ae43544cc24470a1d42efcb5ec959b63c" > takeImage</ a > (< a class = "el" href = "classrtabmap_1_1SensorCaptureInfo.html" > SensorCaptureInfo</ a > *info=0)</ td ></ tr >
< tr class = "separator:ae43544cc24470a1d42efcb5ec959b63c inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a5cfb75ca3d5f63e0c31633a2effae716 inherit pub_methods_classrtabmap_1_1Camera" id = "r_a5cfb75ca3d5f63e0c31633a2effae716" >< td class = "memItemLeft" align = "right" valign = "top" > float  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1Camera.html#a5cfb75ca3d5f63e0c31633a2effae716" > getImageRate</ a > () const</ td ></ tr >
< tr class = "separator:a5cfb75ca3d5f63e0c31633a2effae716 inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a2b89ca2dcbe020c4026d19900268311c inherit pub_methods_classrtabmap_1_1Camera" id = "r_a2b89ca2dcbe020c4026d19900268311c" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1Camera.html#a2b89ca2dcbe020c4026d19900268311c" > setImageRate</ a > (float imageRate)</ td ></ tr >
< tr class = "separator:a2b89ca2dcbe020c4026d19900268311c inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:af03be5ebafb6ebf9341d8de8d7fea4c5 inherit pub_methods_classrtabmap_1_1Camera" id = "r_af03be5ebafb6ebf9341d8de8d7fea4c5" >< td class = "memItemLeft" align = "right" valign = "top" >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > setInterIMUPublishing</ b > (bool enabled, < a class = "el" href = "classrtabmap_1_1IMUFilter.html" > IMUFilter</ a > *filter=0, bool baseFrameConversion=false)</ td ></ tr >
< tr class = "separator:af03be5ebafb6ebf9341d8de8d7fea4c5 inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ac1f77dd10cc2f6e4f75d087c29726802 inherit pub_methods_classrtabmap_1_1Camera" id = "r_ac1f77dd10cc2f6e4f75d087c29726802" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1Camera.html#ac1f77dd10cc2f6e4f75d087c29726802" > isInterIMUPublishing</ a > () const</ td ></ tr >
< tr class = "separator:ac1f77dd10cc2f6e4f75d087c29726802 inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a03f166a742e250d7db2693affe92c387 inherit pub_methods_classrtabmap_1_1Camera" id = "r_a03f166a742e250d7db2693affe92c387" >< td class = "memItemLeft" align = "right" valign = "top" >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > initFromFile</ b > (const std::string & calibrationPath)</ td ></ tr >
< tr class = "separator:a03f166a742e250d7db2693affe92c387 inherit pub_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_classrtabmap_1_1SensorCapture" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_classrtabmap_1_1SensorCapture')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "classrtabmap_1_1SensorCapture.html" > rtabmap::SensorCapture</ a ></ td ></ tr >
< tr class = "memitem:a0578f6540ecdf8c4b3b747d511ecb625 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_a0578f6540ecdf8c4b3b747d511ecb625" >< td class = "memItemLeft" align = "right" valign = "top" >
virtual  </ td >< td class = "memItemRight" valign = "bottom" >< b > ~SensorCapture</ b > ()</ td ></ tr >
< tr class = "memdesc:a0578f6540ecdf8c4b3b747d511ecb625 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Virtual destructor. < br /></ td ></ tr >
< tr class = "separator:a0578f6540ecdf8c4b3b747d511ecb625 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aca06c645212a7501a246ea593406bcaf inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_aca06c645212a7501a246ea593406bcaf" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "classrtabmap_1_1SensorData.html" > SensorData</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#aca06c645212a7501a246ea593406bcaf" > takeData</ a > (< a class = "el" href = "classrtabmap_1_1SensorCaptureInfo.html" > SensorCaptureInfo</ a > *info=0)</ td ></ tr >
< tr class = "memdesc:aca06c645212a7501a246ea593406bcaf inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Captures sensor data with frame rate control. < br /></ td ></ tr >
< tr class = "separator:aca06c645212a7501a246ea593406bcaf inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aee217767808a9df9c63a27b284461c89 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_aee217767808a9df9c63a27b284461c89" >< td class = "memItemLeft" align = "right" valign = "top" > virtual bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#aee217767808a9df9c63a27b284461c89" > odomProvided</ a > () const</ td ></ tr >
< tr class = "memdesc:aee217767808a9df9c63a27b284461c89 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Checks if the sensor provides odometry poses. < br /></ td ></ tr >
< tr class = "separator:aee217767808a9df9c63a27b284461c89 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a2f940d75366088bfae0164e1803ffe9a inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_a2f940d75366088bfae0164e1803ffe9a" >< td class = "memItemLeft" align = "right" valign = "top" > virtual bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#a2f940d75366088bfae0164e1803ffe9a" > getPose</ a > (double stamp, < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > & pose, cv::Mat & covariance, double maxWaitTime=0.06)</ td ></ tr >
< tr class = "memdesc:a2f940d75366088bfae0164e1803ffe9a inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the sensor's pose estimate at a specific timestamp. < br /></ td ></ tr >
< tr class = "separator:a2f940d75366088bfae0164e1803ffe9a inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:af7de847c118ec1ba77a5c9f29f7efece inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_af7de847c118ec1ba77a5c9f29f7efece" >< td class = "memItemLeft" align = "right" valign = "top" > float  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#af7de847c118ec1ba77a5c9f29f7efece" > getFrameRate</ a > () const</ td ></ tr >
< tr class = "memdesc:af7de847c118ec1ba77a5c9f29f7efece inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Returns the target frame rate. < br /></ td ></ tr >
< tr class = "separator:af7de847c118ec1ba77a5c9f29f7efece inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a99829249c51fd08c32310b788b00b663 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_a99829249c51fd08c32310b788b00b663" >< td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#a99829249c51fd08c32310b788b00b663" > getLocalTransform</ a > () const</ td ></ tr >
< tr class = "memdesc:a99829249c51fd08c32310b788b00b663 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Returns the local transform from base frame to sensor frame. < br /></ td ></ tr >
< tr class = "separator:a99829249c51fd08c32310b788b00b663 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a1e195970f52334094174783c5fd06456 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_a1e195970f52334094174783c5fd06456" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#a1e195970f52334094174783c5fd06456" > setFrameRate</ a > (float frameRate)</ td ></ tr >
< tr class = "memdesc:a1e195970f52334094174783c5fd06456 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Sets the target frame rate. < br /></ td ></ tr >
< tr class = "separator:a1e195970f52334094174783c5fd06456 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0ea4e217047c234bcfcb9866e36ea7c0 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_a0ea4e217047c234bcfcb9866e36ea7c0" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#a0ea4e217047c234bcfcb9866e36ea7c0" > setLocalTransform</ a > (const < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > & localTransform)</ td ></ tr >
< tr class = "memdesc:a0ea4e217047c234bcfcb9866e36ea7c0 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Sets the local transform from base frame to sensor frame. < br /></ td ></ tr >
< tr class = "separator:a0ea4e217047c234bcfcb9866e36ea7c0 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:afa9923bb4a3b88e6dbf4c8ae7f060437 inherit pub_methods_classrtabmap_1_1SensorCapture" id = "r_afa9923bb4a3b88e6dbf4c8ae7f060437" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#afa9923bb4a3b88e6dbf4c8ae7f060437" > resetTimer</ a > ()</ td ></ tr >
< tr class = "memdesc:afa9923bb4a3b88e6dbf4c8ae7f060437 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Resets the frame rate timer. < br /></ td ></ tr >
< tr class = "separator:afa9923bb4a3b88e6dbf4c8ae7f060437 inherit pub_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-static-methods" name = "pub-static-methods" ></ a >
Static Public Member Functions</ h2 ></ td ></ tr >
< tr class = "memitem:a7437c782042b437c00fab2785f3071fe" id = "r_a7437c782042b437c00fab2785f3071fe" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a7437c782042b437c00fab2785f3071fe" name = "a7437c782042b437c00fab2785f3071fe" ></ a >
static bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > available</ b > ()</ td ></ tr >
< tr class = "separator:a7437c782042b437c00fab2785f3071fe" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a10731bd2677a0f8c243c533a1395aa83" id = "r_a10731bd2677a0f8c243c533a1395aa83" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a10731bd2677a0f8c243c533a1395aa83" name = "a10731bd2677a0f8c243c533a1395aa83" ></ a >
static bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > exposureGainAvailable</ b > ()</ td ></ tr >
< tr class = "separator:a10731bd2677a0f8c243c533a1395aa83" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pro-methods" name = "pro-methods" ></ a >
Protected Member Functions</ h2 ></ td ></ tr >
< tr class = "memitem:ac84acb8c8fca4507b751c7cbbcbcf8f2" id = "r_ac84acb8c8fca4507b751c7cbbcbcf8f2" >< td class = "memItemLeft" align = "right" valign = "top" > virtual < a class = "el" href = "classrtabmap_1_1SensorData.html" > SensorData</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1CameraOpenNI2.html#ac84acb8c8fca4507b751c7cbbcbcf8f2" > captureImage</ a > (< a class = "el" href = "classrtabmap_1_1SensorCaptureInfo.html" > SensorCaptureInfo</ a > *info=0)</ td ></ tr >
< tr class = "separator:ac84acb8c8fca4507b751c7cbbcbcf8f2" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pro_methods_classrtabmap_1_1Camera" >< td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_classrtabmap_1_1Camera')" >< img src = "closed.png" alt = "-" />   Protected Member Functions inherited from < a class = "el" href = "classrtabmap_1_1Camera.html" > rtabmap::Camera</ a ></ td ></ tr >
< tr class = "memitem:aaae7434ffa5e54f5006355779d335dd3 inherit pro_methods_classrtabmap_1_1Camera" id = "r_aaae7434ffa5e54f5006355779d335dd3" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1Camera.html#aaae7434ffa5e54f5006355779d335dd3" > Camera</ a > (float imageRate=0, const < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > & localTransform=< a class = "el" href = "classrtabmap_1_1Transform.html#a8ea4368f2018d751d2733038081d56a2" > Transform::getIdentity</ a > ())</ td ></ tr >
< tr class = "separator:aaae7434ffa5e54f5006355779d335dd3 inherit pro_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a90c716bf4383af63b275dd9b5e7ec1a6 inherit pro_methods_classrtabmap_1_1Camera" id = "r_a90c716bf4383af63b275dd9b5e7ec1a6" >< td class = "memItemLeft" align = "right" valign = "top" >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > postInterIMU</ b > (const < a class = "el" href = "classrtabmap_1_1IMU.html" > IMU</ a > & imu, double stamp)</ td ></ tr >
< tr class = "separator:a90c716bf4383af63b275dd9b5e7ec1a6 inherit pro_methods_classrtabmap_1_1Camera" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pro_methods_classrtabmap_1_1SensorCapture" >< td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_classrtabmap_1_1SensorCapture')" >< img src = "closed.png" alt = "-" />   Protected Member Functions inherited from < a class = "el" href = "classrtabmap_1_1SensorCapture.html" > rtabmap::SensorCapture</ a ></ td ></ tr >
< tr class = "memitem:adf4b1dfd8e5b45b8eecf938a92dbae94 inherit pro_methods_classrtabmap_1_1SensorCapture" id = "r_adf4b1dfd8e5b45b8eecf938a92dbae94" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#adf4b1dfd8e5b45b8eecf938a92dbae94" > SensorCapture</ a > (float frameRate=0, const < a class = "el" href = "classrtabmap_1_1Transform.html" > Transform</ a > & localTransform=< a class = "el" href = "classrtabmap_1_1Transform.html#a8ea4368f2018d751d2733038081d56a2" > Transform::getIdentity</ a > ())</ td ></ tr >
< tr class = "memdesc:adf4b1dfd8e5b45b8eecf938a92dbae94 inherit pro_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Protected constructor. < br /></ td ></ tr >
< tr class = "separator:adf4b1dfd8e5b45b8eecf938a92dbae94 inherit pro_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acbffaf17772639bc65b0a5457bc56b22 inherit pro_methods_classrtabmap_1_1SensorCapture" id = "r_acbffaf17772639bc65b0a5457bc56b22" >< td class = "memItemLeft" align = "right" valign = "top" > int  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classrtabmap_1_1SensorCapture.html#acbffaf17772639bc65b0a5457bc56b22" > getNextSeqID</ a > ()</ td ></ tr >
< tr class = "memdesc:acbffaf17772639bc65b0a5457bc56b22 inherit pro_methods_classrtabmap_1_1SensorCapture" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the next sequence ID. < br /></ td ></ tr >
< tr class = "separator:acbffaf17772639bc65b0a5457bc56b22 inherit pro_methods_classrtabmap_1_1SensorCapture" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >
< p class = "definition" > Definition at line < a class = "el" href = "CameraOpenNI2_8h_source.html#l00042" > 42</ a > of file < a class = "el" href = "CameraOpenNI2_8h_source.html" > CameraOpenNI2.h</ a > .</ p >
</ div >< h2 class = "groupheader" > Member Enumeration Documentation</ h2 >
< a id = "add2f5250ec9d897654f31cf286bc692e" name = "add2f5250ec9d897654f31cf286bc692e" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#add2f5250ec9d897654f31cf286bc692e" > ◆  </ a ></ span > Type</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum rtabmap::CameraOpenNI2::Type</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "CameraOpenNI2_8h_source.html#l00049" > 49</ a > of file < a class = "el" href = "CameraOpenNI2_8h_source.html" > CameraOpenNI2.h</ a > .</ p >
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
< a id = "a0c0da722b985da3595896fcc6bc72c7b" name = "a0c0da722b985da3595896fcc6bc72c7b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0c0da722b985da3595896fcc6bc72c7b" > ◆  </ a ></ span > init()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool rtabmap::CameraOpenNI2::init </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > calibrationFolder</ em > = < code > " ." </ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > cameraName</ em > = < code > "" </ code >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ 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 > Initializes the sensor. </ p >
< p > Pure virtual method that must be implemented by derived classes to initialize the sensor hardware or data source. This typically involves:</ p >< ul >
< li > Opening device connections or file streams</ li >
< li > Loading camera calibration parameters</ li >
< li > Configuring sensor settings</ li >
</ ul >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > calibrationFolder</ td >< td > Directory path where calibration files are located (default: current directory ".") </ td ></ tr >
< tr >< td class = "paramname" > cameraName</ td >< td > Base name of the camera for loading calibration files (default: empty string) </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if initialization was successful, false otherwise</ dd ></ dl >
< dl class = "section note" >< dt > Note</ dt >< dd > Must be called before calling < a class = "el" href = "classrtabmap_1_1SensorCapture.html#aca06c645212a7501a246ea593406bcaf" title = "Captures sensor data with frame rate control." > takeData()</ a > or captureData() </ dd ></ dl >
< p > Implements < a class = "el" href = "classrtabmap_1_1SensorCapture.html#a1c0cd843969fab53f157cbe0fd333b8a" > rtabmap::SensorCapture</ a > .</ p >
</ div >
</ div >
< a id = "aed4c35163df8651021190f6dffe66407" name = "aed4c35163df8651021190f6dffe66407" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aed4c35163df8651021190f6dffe66407" > ◆  </ a ></ span > isCalibrated()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool rtabmap::CameraOpenNI2::isCalibrated </ td >
< td > (</ td >
< td class = "paramname" ></ 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 > Implements < a class = "el" href = "classrtabmap_1_1Camera.html" > rtabmap::Camera</ a > .</ p >
</ div >
</ div >
< a id = "a9767b92c3df7b637c75ee351208e3f0b" name = "a9767b92c3df7b637c75ee351208e3f0b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a9767b92c3df7b637c75ee351208e3f0b" > ◆  </ a ></ span > getSerial()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual std::string rtabmap::CameraOpenNI2::getSerial </ td >
< td > (</ td >
< td class = "paramname" ></ 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 > Returns the sensor's serial number or unique identifier. </ p >
< p > Pure virtual method that must be implemented by derived classes to return a unique identifier for the sensor (e.g., device serial number, file path, or other identifier).</ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > String identifier for the sensor </ dd ></ dl >
< p > Implements < a class = "el" href = "classrtabmap_1_1SensorCapture.html#a7830e571e45752f9d8f30fa806f6aa64" > rtabmap::SensorCapture</ a > .</ p >
</ div >
</ div >
< a id = "ac84acb8c8fca4507b751c7cbbcbcf8f2" name = "ac84acb8c8fca4507b751c7cbbcbcf8f2" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ac84acb8c8fca4507b751c7cbbcbcf8f2" > ◆  </ a ></ span > captureImage()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual < a class = "el" href = "classrtabmap_1_1SensorData.html" > SensorData</ a > rtabmap::CameraOpenNI2::captureImage </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "classrtabmap_1_1SensorCaptureInfo.html" > SensorCaptureInfo</ a > *  </ td >
< td class = "paramname" >< em > info</ em > = < code > 0</ code ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > protected</ span >< span class = "mlabel" > virtual</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Implements < a class = "el" href = "classrtabmap_1_1Camera.html" > rtabmap::Camera</ a > .</ p >
</ div >
</ div >
< hr /> The documentation for this class was generated from the following file:< ul >
< li > corelib/include/rtabmap/core/camera/< a class = "el" href = "CameraOpenNI2_8h_source.html" > CameraOpenNI2.h</ a ></ li >
</ ul >
</ div > <!-- contents -->
2026-08-02 07:56:38 +00:00
</ div > <!-- doc-content -->
2026-08-02 01:36:11 +00:00
<!-- start footer part -->
2026-08-02 07:56:38 +00:00
< 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_1CameraOpenNI2.html" > CameraOpenNI2</ 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 >
2026-08-02 01:36:11 +00:00
</ body >
</ html >
