rtabmap::CameraOpenNI2 Class Reference

Inheritance diagram for rtabmap::CameraOpenNI2:

Collaboration diagram for rtabmap::CameraOpenNI2:

Public Types
enum	Type { kTypeColorDepth , kTypeIRDepth , kTypeIR }

Public Member Functions
	CameraOpenNI2 (const std::string &deviceId="", Type type=kTypeColorDepth, float imageRate=0, const Transform &localTransform=Transform::getIdentity())
virtual bool	init (const std::string &calibrationFolder=".", const std::string &cameraName="")
	Initializes the sensor.
virtual bool	isCalibrated () const
virtual std::string	getSerial () const
	Returns the sensor's serial number or unique identifier.
bool	setAutoWhiteBalance (bool enabled)
bool	setAutoExposure (bool enabled)
bool	setExposure (int value)
bool	setGain (int value)
bool	setMirroring (bool enabled)
void	setOpenNI2StampsAndIDsUsed (bool used)
void	setIRDepthShift (int horizontal, int vertical)
void	setDepthDecimation (int decimation)
Public Member Functions inherited from rtabmap::Camera
SensorData	takeImage (SensorCaptureInfo *info=0)
float	getImageRate () const
void	setImageRate (float imageRate)
void	setInterIMUPublishing (bool enabled, IMUFilter *filter=0, bool baseFrameConversion=false)
bool	isInterIMUPublishing () const
bool	initFromFile (const std::string &calibrationPath)
Public Member Functions inherited from rtabmap::SensorCapture
virtual	~SensorCapture ()
	Virtual destructor.
SensorData	takeData (SensorCaptureInfo *info=0)
	Captures sensor data with frame rate control.
virtual bool	odomProvided () const
	Checks if the sensor provides odometry poses.
virtual bool	getPose (double stamp, Transform &pose, cv::Mat &covariance, double maxWaitTime=0.06)
	Gets the sensor's pose estimate at a specific timestamp.
float	getFrameRate () const
	Returns the target frame rate.
const Transform &	getLocalTransform () const
	Returns the local transform from base frame to sensor frame.
void	setFrameRate (float frameRate)
	Sets the target frame rate.
void	setLocalTransform (const Transform &localTransform)
	Sets the local transform from base frame to sensor frame.
void	resetTimer ()
	Resets the frame rate timer.

Static Public Member Functions
static bool	available ()
static bool	exposureGainAvailable ()

Protected Member Functions
virtual SensorData	captureImage (SensorCaptureInfo *info=0)
Protected Member Functions inherited from rtabmap::Camera
	Camera (float imageRate=0, const Transform &localTransform=Transform::getIdentity())
void	postInterIMU (const IMU &imu, double stamp)
Protected Member Functions inherited from rtabmap::SensorCapture
	SensorCapture (float frameRate=0, const Transform &localTransform=Transform::getIdentity())
	Protected constructor.
int	getNextSeqID ()
	Gets the next sequence ID.

Detailed Description

Definition at line 42 of file CameraOpenNI2.h.

Member Enumeration Documentation

Type

enum rtabmap::CameraOpenNI2::Type

Definition at line 49 of file CameraOpenNI2.h.

Member Function Documentation

init()

virtual bool rtabmap::CameraOpenNI2::init ( const std::string &  calibrationFolder = ".", const std::string &  cameraName = ""  )

virtual

Initializes the sensor.

Pure virtual method that must be implemented by derived classes to initialize the sensor hardware or data source. This typically involves:

• Opening device connections or file streams
• Loading camera calibration parameters
• Configuring sensor settings

Parameters

calibrationFolder	Directory path where calibration files are located (default: current directory ".")
cameraName	Base name of the camera for loading calibration files (default: empty string)

Returns

True if initialization was successful, false otherwise

Note

Must be called before calling takeData() or captureData()

Implements rtabmap::SensorCapture.

isCalibrated()

virtual bool rtabmap::CameraOpenNI2::isCalibrated ( ) const

virtual

Implements rtabmap::Camera.

getSerial()

virtual std::string rtabmap::CameraOpenNI2::getSerial ( ) const

virtual

Returns the sensor's serial number or unique identifier.

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).

Returns

String identifier for the sensor

Implements rtabmap::SensorCapture.

captureImage()

virtual SensorData rtabmap::CameraOpenNI2::captureImage ( SensorCaptureInfo *  info = 0 )

protectedvirtual

Implements rtabmap::Camera.

---

The documentation for this class was generated from the following file:

• corelib/include/rtabmap/core/camera/CameraOpenNI2.h