Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
rtabmap::Odometry Class Referenceabstract

#include <Odometry.h>

Inheritance diagram for rtabmap::Odometry:
Inheritance graph
[legend]

Public Types

enum  Type {
  kTypeUndef = -1, kTypeF2M = 0, kTypeF2F = 1, kTypeFovis = 2,
  kTypeViso2 = 3, kTypeDVO = 4, kTypeORBSLAM = 5, kTypeOkvis = 6,
  kTypeLOAM = 7, kTypeMSCKF = 8, kTypeVINS = 9, kTypeOpenVINS = 10,
  kTypeFLOAM = 11, kTypeOpen3D = 12
}
 

Public Member Functions

virtual bool canProcessAsyncIMU () const
 
virtual bool canProcessRawImages () const
 
unsigned int framesProcessed () const
 
const Transform & getPose () const
 
virtual Odometry::Type getType ()=0
 
const Transform & getVelocityGuess () const
 
bool imagesAlreadyRectified () const
 
bool isInfoDataFilled () const
 
double previousStamp () const
 
Transform process (SensorData &data, OdometryInfo *info=0)
 
Transform process (SensorData &data, const Transform &guess, OdometryInfo *info=0)
 
virtual void reset (const Transform &initialPose=Transform::getIdentity())
 
 RTABMAP_DEPRECATED (const Transform &previousVelocityTransform() const, "Use getVelocityGuess() instead.")
 
virtual ~Odometry ()
 

Static Public Member Functions

static Odometry * create (const ParametersMap &parameters=ParametersMap())
 
static Odometry * create (Type &type, const ParametersMap &parameters=ParametersMap())
 

Protected Member Functions

const std::map< double, Transform > & imus () const
 
 Odometry (const rtabmap::ParametersMap &parameters)
 

Private Member Functions

virtual Transform computeTransform (SensorData &data, const Transform &guess=Transform(), OdometryInfo *info=0)=0
 
void initKalmanFilter (const Transform &initialPose=Transform::getIdentity(), float vx=0.0f, float vy=0.0f, float vz=0.0f, float vroll=0.0f, float vpitch=0.0f, float vyaw=0.0f)
 
void predictKalmanFilter (float dt, float *vx=0, float *vy=0, float *vz=0, float *vroll=0, float *vpitch=0, float *vyaw=0)
 
void updateKalmanFilter (float &vx, float &vy, float &vz, float &vroll, float &vpitch, float &vyaw)
 

Private Attributes

bool _alignWithGround
 
bool _fillInfoData
 
int _filteringStrategy
 
bool _force3DoF
 
bool _holonomic
 
unsigned int _imageDecimation
 
bool _imagesAlreadyRectified
 
float _kalmanMeasurementNoise
 
float _kalmanProcessNoise
 
float _particleLambdaR
 
float _particleLambdaT
 
float _particleNoiseR
 
float _particleNoiseT
 
int _particleSize
 
Transform _pose
 
bool _publishRAMUsage
 
int _resetCountdown
 
int _resetCurrentCount
 
float distanceTravelled_
 
unsigned int framesProcessed_
 
bool guessFromMotion_
 
float guessSmoothingDelay_
 
Transform imuLastTransform_
 
std::map< double, Transform > imus_
 
cv::KalmanFilter kalmanFilter_
 
std::vector< CameraModel > models_
 
std::vector< ParticleFilter * > particleFilters_
 
Transform previousGroundTruthPose_
 
double previousStamp_
 
std::list< std::pair< std::vector< float >, double > > previousVelocities_
 
std::vector< StereoCameraModel > stereoModels_
 
Transform velocityGuess_
 

Detailed Description

Definition at line 42 of file Odometry.h.

Member Enumeration Documentation

◆ Type

enum rtabmap::Odometry::Type
Enumerator
kTypeUndef 
kTypeF2M 
kTypeF2F 
kTypeFovis 
kTypeViso2 
kTypeDVO 
kTypeORBSLAM 
kTypeOkvis 
kTypeLOAM 
kTypeMSCKF 
kTypeVINS 
kTypeOpenVINS 
kTypeFLOAM 
kTypeOpen3D 

Definition at line 45 of file Odometry.h.

Constructor & Destructor Documentation

◆ ~Odometry()

rtabmap::Odometry::~Odometry ( )
virtual

Definition at line 195 of file Odometry.cpp.

◆ Odometry()

rtabmap::Odometry::Odometry ( const rtabmap::ParametersMap &  parameters)
protected

Definition at line 119 of file Odometry.cpp.

Member Function Documentation

◆ canProcessAsyncIMU()

virtual bool rtabmap::Odometry::canProcessAsyncIMU ( ) const
inlinevirtual

Reimplemented in rtabmap::OdometryORBSLAM, rtabmap::OdometryOkvis, rtabmap::OdometryOpenVINS, rtabmap::OdometryMSCKF, and rtabmap::OdometryVINS.

Definition at line 73 of file Odometry.h.

◆ canProcessRawImages()

virtual bool rtabmap::Odometry::canProcessRawImages ( ) const
inlinevirtual

Reimplemented in rtabmap::OdometryOkvis, rtabmap::OdometryOpenVINS, rtabmap::OdometryMSCKF, and rtabmap::OdometryVINS.

Definition at line 72 of file Odometry.h.

◆ computeTransform()

virtual Transform rtabmap::Odometry::computeTransform ( SensorData &  data,
const Transform &  guess = Transform(),
OdometryInfo *  info = 0 
)
privatepure virtual

Implemented in rtabmap::OdometryF2M, rtabmap::OdometryORBSLAM, rtabmap::OdometryDVO, rtabmap::OdometryFovis, rtabmap::OdometryLOAM, rtabmap::OdometryOkvis, rtabmap::OdometryF2F, rtabmap::OdometryOpenVINS, rtabmap::OdometryMSCKF, rtabmap::OdometryVINS, rtabmap::OdometryFLOAM, rtabmap::OdometryMono, rtabmap::OdometryViso2, and rtabmap::OdometryOpen3D.

◆ create() [1/2]

Odometry * rtabmap::Odometry::create ( const ParametersMap &  parameters = ParametersMap())
static

Definition at line 57 of file Odometry.cpp.

◆ create() [2/2]

Odometry * rtabmap::Odometry::create ( Odometry::Type &  type,
const ParametersMap &  parameters = ParametersMap() 
)
static

Definition at line 65 of file Odometry.cpp.

◆ framesProcessed()

unsigned int rtabmap::Odometry::framesProcessed ( ) const
inline

Definition at line 81 of file Odometry.h.

◆ getPose()

const Transform& rtabmap::Odometry::getPose ( ) const
inline

Definition at line 76 of file Odometry.h.

◆ getType()

virtual Odometry::Type rtabmap::Odometry::getType ( )
pure virtual

Implemented in rtabmap::OdometryF2M, rtabmap::OdometryORBSLAM, rtabmap::OdometryDVO, rtabmap::OdometryFovis, rtabmap::OdometryLOAM, rtabmap::OdometryF2F, rtabmap::OdometryOkvis, rtabmap::OdometryOpenVINS, rtabmap::OdometryFLOAM, rtabmap::OdometryMono, rtabmap::OdometryMSCKF, rtabmap::OdometryVINS, rtabmap::OdometryViso2, and rtabmap::OdometryOpen3D.

◆ getVelocityGuess()

const Transform& rtabmap::Odometry::getVelocityGuess ( ) const
inline

Definition at line 79 of file Odometry.h.

◆ imagesAlreadyRectified()

bool rtabmap::Odometry::imagesAlreadyRectified ( ) const
inline

Definition at line 82 of file Odometry.h.

◆ imus()

const std::map<double, Transform>& rtabmap::Odometry::imus ( ) const
inlineprotected

Definition at line 85 of file Odometry.h.

◆ initKalmanFilter()

void rtabmap::Odometry::initKalmanFilter ( const Transform &  initialPose = Transform::getIdentity(),
float  vx = 0.0f,
float  vy = 0.0f,
float  vz = 0.0f,
float  vroll = 0.0f,
float  vpitch = 0.0f,
float  vyaw = 0.0f 
)
private

Definition at line 915 of file Odometry.cpp.

◆ isInfoDataFilled()

bool rtabmap::Odometry::isInfoDataFilled ( ) const
inline

Definition at line 77 of file Odometry.h.

◆ predictKalmanFilter()

void rtabmap::Odometry::predictKalmanFilter ( float  dt,
float *  vx = 0,
float *  vy = 0,
float *  vz = 0,
float *  vroll = 0,
float *  vpitch = 0,
float *  vyaw = 0 
)
private

Definition at line 1007 of file Odometry.cpp.

◆ previousStamp()

double rtabmap::Odometry::previousStamp ( ) const
inline

Definition at line 80 of file Odometry.h.

◆ process() [1/2]

Transform rtabmap::Odometry::process ( SensorData &  data,
OdometryInfo *  info = 0 
)

Definition at line 291 of file Odometry.cpp.

◆ process() [2/2]

Transform rtabmap::Odometry::process ( SensorData &  data,
const Transform &  guess,
OdometryInfo *  info = 0 
)

Definition at line 296 of file Odometry.cpp.

◆ reset()

void rtabmap::Odometry::reset ( const Transform &  initialPose = Transform::getIdentity())
virtual

Reimplemented in rtabmap::OdometryORBSLAM, rtabmap::OdometryF2M, rtabmap::OdometryDVO, rtabmap::OdometryFovis, rtabmap::OdometryLOAM, rtabmap::OdometryOkvis, rtabmap::OdometryOpenVINS, rtabmap::OdometryF2F, rtabmap::OdometryFLOAM, rtabmap::OdometryMono, rtabmap::OdometryMSCKF, rtabmap::OdometryVINS, rtabmap::OdometryViso2, and rtabmap::OdometryOpen3D.

Definition at line 203 of file Odometry.cpp.

◆ RTABMAP_DEPRECATED()

rtabmap::Odometry::RTABMAP_DEPRECATED ( const Transform &previousVelocityTransform()  const,
"Use getVelocityGuess() instead."   
)

◆ updateKalmanFilter()

void rtabmap::Odometry::updateKalmanFilter ( float &  vx,
float &  vy,
float &  vz,
float &  vroll,
float &  vpitch,
float &  vyaw 
)
private

Definition at line 1093 of file Odometry.cpp.

Member Data Documentation

◆ _alignWithGround

bool rtabmap::Odometry::_alignWithGround
private

Definition at line 110 of file Odometry.h.

◆ _fillInfoData

bool rtabmap::Odometry::_fillInfoData
private

Definition at line 106 of file Odometry.h.

◆ _filteringStrategy

int rtabmap::Odometry::_filteringStrategy
private

Definition at line 100 of file Odometry.h.

◆ _force3DoF

bool rtabmap::Odometry::_force3DoF
private

Definition at line 96 of file Odometry.h.

◆ _holonomic

bool rtabmap::Odometry::_holonomic
private

Definition at line 97 of file Odometry.h.

◆ _imageDecimation

unsigned int rtabmap::Odometry::_imageDecimation
private

Definition at line 109 of file Odometry.h.

◆ _imagesAlreadyRectified

bool rtabmap::Odometry::_imagesAlreadyRectified
private

Definition at line 112 of file Odometry.h.

◆ _kalmanMeasurementNoise

float rtabmap::Odometry::_kalmanMeasurementNoise
private

Definition at line 108 of file Odometry.h.

◆ _kalmanProcessNoise

float rtabmap::Odometry::_kalmanProcessNoise
private

Definition at line 107 of file Odometry.h.

◆ _particleLambdaR

float rtabmap::Odometry::_particleLambdaR
private

Definition at line 105 of file Odometry.h.

◆ _particleLambdaT

float rtabmap::Odometry::_particleLambdaT
private

Definition at line 103 of file Odometry.h.

◆ _particleNoiseR

float rtabmap::Odometry::_particleNoiseR
private

Definition at line 104 of file Odometry.h.

◆ _particleNoiseT

float rtabmap::Odometry::_particleNoiseT
private

Definition at line 102 of file Odometry.h.

◆ _particleSize

int rtabmap::Odometry::_particleSize
private

Definition at line 101 of file Odometry.h.

◆ _pose

Transform rtabmap::Odometry::_pose
private

Definition at line 113 of file Odometry.h.

◆ _publishRAMUsage

bool rtabmap::Odometry::_publishRAMUsage
private

Definition at line 111 of file Odometry.h.

◆ _resetCountdown

int rtabmap::Odometry::_resetCountdown
private

Definition at line 95 of file Odometry.h.

◆ _resetCurrentCount

int rtabmap::Odometry::_resetCurrentCount
private

Definition at line 114 of file Odometry.h.

◆ distanceTravelled_

float rtabmap::Odometry::distanceTravelled_
private

Definition at line 120 of file Odometry.h.

◆ framesProcessed_

unsigned int rtabmap::Odometry::framesProcessed_
private

Definition at line 121 of file Odometry.h.

◆ guessFromMotion_

bool rtabmap::Odometry::guessFromMotion_
private

Definition at line 98 of file Odometry.h.

◆ guessSmoothingDelay_

float rtabmap::Odometry::guessSmoothingDelay_
private

Definition at line 99 of file Odometry.h.

◆ imuLastTransform_

Transform rtabmap::Odometry::imuLastTransform_
private

Definition at line 118 of file Odometry.h.

◆ imus_

std::map<double, Transform> rtabmap::Odometry::imus_
private

Definition at line 127 of file Odometry.h.

◆ kalmanFilter_

cv::KalmanFilter rtabmap::Odometry::kalmanFilter_
private

Definition at line 124 of file Odometry.h.

◆ models_

std::vector<CameraModel> rtabmap::Odometry::models_
private

Definition at line 126 of file Odometry.h.

◆ particleFilters_

std::vector<ParticleFilter *> rtabmap::Odometry::particleFilters_
private

Definition at line 123 of file Odometry.h.

◆ previousGroundTruthPose_

Transform rtabmap::Odometry::previousGroundTruthPose_
private

Definition at line 119 of file Odometry.h.

◆ previousStamp_

double rtabmap::Odometry::previousStamp_
private

Definition at line 115 of file Odometry.h.

◆ previousVelocities_

std::list<std::pair<std::vector<float>, double> > rtabmap::Odometry::previousVelocities_
private

Definition at line 116 of file Odometry.h.

◆ stereoModels_

std::vector<StereoCameraModel> rtabmap::Odometry::stereoModels_
private

Definition at line 125 of file Odometry.h.

◆ velocityGuess_

Transform rtabmap::Odometry::velocityGuess_
private

Definition at line 117 of file Odometry.h.

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

rtabmap
Author(s): Mathieu Labbe
autogenerated on Mon Jan 23 2023 03:39:00