Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
gtsam::BarometricFactor Class Reference

#include <BarometricFactor.h>

Inheritance diagram for gtsam::BarometricFactor:
Inheritance graph
[legend]

Public Types

typedef std::shared_ptr< BarometricFactorshared_ptr
 shorthand for a smart pointer to a factor More...
 
typedef BarometricFactor This
 Typedef to this class. More...
 
- Public Types inherited from gtsam::NoiseModelFactorN< Pose3, double >
enum  
 N is the number of variables (N-way factor) More...
 
using ValueType = typename std::tuple_element< I - 1, std::tuple< ValueTypes... > >::type
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::NonlinearFactor
typedef std::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::Factor
typedef KeyVector::const_iterator const_iterator
 Const iterator over keys. More...
 
typedef KeyVector::iterator iterator
 Iterator over keys. More...
 

Public Member Functions

 BarometricFactor ()
 
 BarometricFactor (Key key, Key baroKey, const double &baroIn, const SharedNoiseModel &model)
 Constructor from a measurement of pressure in KPa. More...
 
double baroOut (const double &meters)
 
gtsam::NonlinearFactor::shared_ptr clone () const override
 
bool equals (const NonlinearFactor &expected, double tol=1e-9) const override
 equals More...
 
Vector evaluateError (const Pose3 &p, const double &b, OptionalMatrixType H, OptionalMatrixType H2) const override
 vector of errors More...
 
double heightOut (double n) const
 
const double & measurementIn () const
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 print More...
 
 ~BarometricFactor () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactorN< Pose3, double >
Key key () const
 
 ~NoiseModelFactorN () override
 
 NoiseModelFactorN ()
 Default Constructor for I/O. More...
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)
 
Vector unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const override
 
virtual Vector evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0
 
Vector evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const
 
Vector evaluateError (const ValueTypes &... x) const
 
AreAllMatrixRefs< Vector, OptionalJacArgs... > evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
 
AreAllMatrixPtrs< Vector, OptionalJacArgs... > evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
 
Key key1 () const
 
Key key2 () const
 
Key key3 () const
 
Key key4 () const
 
Key key5 () const
 
Key key6 () const
 
- Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
 
size_t dim () const override
 
bool equals (const NonlinearFactor &f, double tol=1e-9) const override
 
double error (const Values &c) const override
 
std::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 
const SharedNoiseModelnoiseModel () const
 access to the noise model More...
 
 NoiseModelFactor ()
 
template<typename CONTAINER >
 NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 
Vector unweightedWhitenedError (const Values &c) const
 
Vector unwhitenedError (const Values &x, std::vector< Matrix > &H) const
 
double weight (const Values &c) const
 
Vector whitenedError (const Values &c) const
 
 ~NoiseModelFactor () override
 
- Public Member Functions inherited from gtsam::NonlinearFactor
 NonlinearFactor ()
 
template<typename CONTAINER >
 NonlinearFactor (const CONTAINER &keys)
 
double error (const HybridValues &c) const override
 
virtual bool active (const Values &) const
 
virtual shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 
virtual shared_ptr rekey (const KeyVector &new_keys) const
 
virtual bool sendable () const
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor. More...
 
bool empty () const
 Whether the factor is empty (involves zero variables). More...
 
Key front () const
 First key. More...
 
Key back () const
 Last key. More...
 
const_iterator find (Key key) const
 find More...
 
const KeyVectorkeys () const
 Access the factor's involved variable keys. More...
 
const_iterator begin () const
 
const_iterator end () const
 
size_t size () const
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys More...
 
bool equals (const This &other, double tol=1e-9) const
 check equality More...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Private Types

typedef NoiseModelFactorN< Pose3, double > Base
 

Private Attributes

double nT_
 Height Measurement based on a standard atmosphere. More...
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactorN< Pose3, double >
using Base = NoiseModelFactor
 
using KeyType = Key
 
using MatrixTypeT = Matrix
 
using OptionalMatrixTypeT = Matrix *
 
using This = NoiseModelFactorN< ValueTypes... >
 
using IsConvertible = typename std::enable_if< std::is_convertible< From, To >::value, void >::type
 
using IndexIsValid = typename std::enable_if<(I >=1) &&(I<=N), void >::type
 
using ContainerElementType = typename std::decay< decltype(*std::declval< Container >().begin())>::type
 
using IsContainerOfKeys = IsConvertible< ContainerElementType< Container >, Key >
 
using AreAllMatrixRefs = std::enable_if_t<(... &&std::is_convertible< Args, Matrix &>::value), Ret >
 
using IsMatrixPointer = std::is_same< typename std::decay_t< Arg >, Matrix *>
 
using IsNullpointer = std::is_same< typename std::decay_t< Arg >, std::nullptr_t >
 
using AreAllMatrixPtrs = std::enable_if_t<(... &&(IsMatrixPointer< Args >::value||IsNullpointer< Args >::value)), Ret >
 
- Protected Types inherited from gtsam::NoiseModelFactor
typedef NonlinearFactor Base
 
typedef NoiseModelFactor This
 
- Protected Types inherited from gtsam::NonlinearFactor
typedef Factor Base
 
typedef NonlinearFactor This
 
- Protected Member Functions inherited from gtsam::NoiseModelFactor
 NoiseModelFactor (const SharedNoiseModel &noiseModel)
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 
- Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor FromKeys (const CONTAINER &keys)
 
template<typename ITERATOR >
static Factor FromIterators (ITERATOR first, ITERATOR last)
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor. More...
 

Detailed Description

Prior on height in a cartesian frame. Receive barometric pressure in kilopascals Model with a slowly moving bias to capture differences between the height and the standard atmosphere https://www.grc.nasa.gov/www/k-12/airplane/atmosmet.html

Definition at line 34 of file BarometricFactor.h.

Member Typedef Documentation

◆ Base

Definition at line 36 of file BarometricFactor.h.

◆ shared_ptr

shorthand for a smart pointer to a factor

Definition at line 46 of file BarometricFactor.h.

◆ This

Typedef to this class.

Definition at line 49 of file BarometricFactor.h.

Constructor & Destructor Documentation

◆ BarometricFactor() [1/2]

gtsam::BarometricFactor::BarometricFactor ( )
inline

default constructor - only use for serialization

Definition at line 52 of file BarometricFactor.h.

◆ ~BarometricFactor()

gtsam::BarometricFactor::~BarometricFactor ( )
inlineoverride

Definition at line 54 of file BarometricFactor.h.

◆ BarometricFactor() [2/2]

gtsam::BarometricFactor::BarometricFactor ( Key  key,
Key  baroKey,
const double &  baroIn,
const SharedNoiseModel model 
)
inline

Constructor from a measurement of pressure in KPa.

Parameters
keyof the Pose3 variable that will be constrained
keyof the barometric bias that will be constrained
baroInmeasurement in KPa
modelGaussian noise model 1 dimension

Definition at line 63 of file BarometricFactor.h.

Member Function Documentation

◆ baroOut()

double gtsam::BarometricFactor::baroOut ( const double &  meters)
inline

Definition at line 94 of file BarometricFactor.h.

◆ clone()

gtsam::NonlinearFactor::shared_ptr gtsam::BarometricFactor::clone ( ) const
inlineoverridevirtual
Returns
a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 68 of file BarometricFactor.h.

◆ equals()

bool gtsam::BarometricFactor::equals ( const NonlinearFactor expected,
double  tol = 1e-9 
) const
overridevirtual

equals

Reimplemented from gtsam::NonlinearFactor.

Definition at line 37 of file BarometricFactor.cpp.

◆ evaluateError()

Vector gtsam::BarometricFactor::evaluateError ( const Pose3 p,
const double &  b,
OptionalMatrixType  H,
OptionalMatrixType  H2 
) const
override

vector of errors

Definition at line 45 of file BarometricFactor.cpp.

◆ heightOut()

double gtsam::BarometricFactor::heightOut ( double  n) const
inline

Definition at line 88 of file BarometricFactor.h.

◆ measurementIn()

const double& gtsam::BarometricFactor::measurementIn ( ) const
inline

Definition at line 86 of file BarometricFactor.h.

◆ print()

void gtsam::BarometricFactor::print ( const std::string &  s = "",
const KeyFormatter keyFormatter = DefaultKeyFormatter 
) const
overridevirtual

print

Reimplemented from gtsam::Factor.

Definition at line 26 of file BarometricFactor.cpp.

Member Data Documentation

◆ nT_

double gtsam::BarometricFactor::nT_
private

Height Measurement based on a standard atmosphere.

Definition at line 38 of file BarometricFactor.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:15