Public Member Functions | Public Attributes | List of all members
fcl::Variance3< S > Class Template Reference

Class for variance matrix in 3d. More...

#include <variance3.h>

Public Member Functions

void init ()
 init the Variance More...
 
Variance3< S > & sqrt ()
 Compute the sqrt of Sigma matrix based on the eigen decomposition result, this is useful when the uncertainty matrix is initialized as a square variation matrix. More...
 
 Variance3 ()
 
 Variance3 (const Matrix3< S > &sigma)
 

Public Attributes

Matrix3< S > axis
 Matrix whose columns are eigenvectors of Sigma. More...
 
Matrix3< S > Sigma
 Variation matrix. More...
 
Vector3< S > sigma
 Variations along the eign axes. More...
 

Detailed Description

template<typename S>
class fcl::Variance3< S >

Class for variance matrix in 3d.

Definition at line 51 of file variance3.h.

Constructor & Destructor Documentation

◆ Variance3() [1/2]

template<typename S >
fcl::Variance3< S >::Variance3

Definition at line 52 of file variance3-inl.h.

◆ Variance3() [2/2]

template<typename S >
fcl::Variance3< S >::Variance3 ( const Matrix3< S > &  sigma)

Definition at line 59 of file variance3-inl.h.

Member Function Documentation

◆ init()

template<typename S >
void fcl::Variance3< S >::init

init the Variance

Definition at line 66 of file variance3-inl.h.

◆ sqrt()

template<typename S >
Variance3< S > & fcl::Variance3< S >::sqrt

Compute the sqrt of Sigma matrix based on the eigen decomposition result, this is useful when the uncertainty matrix is initialized as a square variation matrix.

Definition at line 73 of file variance3-inl.h.

Member Data Documentation

◆ axis

template<typename S >
Matrix3<S> fcl::Variance3< S >::axis

Matrix whose columns are eigenvectors of Sigma.

Definition at line 61 of file variance3.h.

◆ Sigma

template<typename S >
Matrix3<S> fcl::Variance3< S >::Sigma

Variation matrix.

Definition at line 55 of file variance3.h.

◆ sigma

template<typename S >
Vector3<S> fcl::Variance3< S >::sigma

Variations along the eign axes.

Definition at line 58 of file variance3.h.


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


fcl
Author(s):
autogenerated on Fri Apr 2 2021 02:38:02