gtsam 4.2.0
gtsam
Loading...
Searching...
No Matches
gtsam::BarometricFactor Class Reference

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

+ Inheritance diagram for gtsam::BarometricFactor:

Public Member Functions

 BarometricFactor ()
 default constructor - only use for serialization
 
 BarometricFactor (Key key, Key baroKey, const double &baroIn, const SharedNoiseModel &model)
 Constructor from a measurement of pressure in KPa.
 
gtsam::NonlinearFactor::shared_ptr clone () const override
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 print
 
bool equals (const NonlinearFactor &expected, double tol=1e-9) const override
 equals
 
Vector evaluateError (const Pose3 &p, const double &b, boost::optional< Matrix & > H=boost::none, boost::optional< Matrix & > H2=boost::none) const override
 vector of errors
 
const double & measurementIn () const
 
double heightOut (double n) const
 
double baroOut (const double &meters)
 
- Public Member Functions inherited from gtsam::NoiseModelFactorN< Pose3, double >
Key key () const
 Returns a key.
 
 NoiseModelFactorN ()
 Default Constructor for I/O.
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)
 Constructor.
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)
 Constructor.
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 This implements the unwhitenedError virtual function by calling the n-key specific version of evaluateError, which is pure virtual so must be implemented in the derived class.
 
virtual Vector evaluateError (const ValueTypes &... x, OptionalMatrix< ValueTypes >... H) const=0
 Override evaluateError to finish implementing an n-way factor.
 
Vector evaluateError (const ValueTypes &... x) const
 No-Jacobians requested function overload.
 
Vector evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
 Some (but not all) optional Jacobians are omitted (function overload)
 
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
 NoiseModelFactor ()
 Default constructor for I/O only.
 
 ~NoiseModelFactor () override
 Destructor.
 
template<typename CONTAINER >
 NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
 Constructor.
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 Print.
 
bool equals (const NonlinearFactor &f, double tol=1e-9) const override
 Check if two factors are equal.
 
size_t dim () const override
 get the dimension of the factor (number of rows on linearization)
 
const SharedNoiseModelnoiseModel () const
 access to the noise model
 
Vector whitenedError (const Values &c) const
 Vector of errors, whitened This is the raw error, i.e., i.e.
 
Vector unweightedWhitenedError (const Values &c) const
 Vector of errors, whitened, but unweighted by any loss function.
 
double weight (const Values &c) const
 Compute the effective weight of the factor from the noise model.
 
double error (const Values &c) const override
 Calculate the error of the factor.
 
boost::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 Linearize a non-linearFactorN to get a GaussianFactor, \( Ax-b \approx h(x+\delta x)-z = h(x) + A \delta x - z \) Hence \( b = z - h(x) = - \mathtt{error\_vector}(x) \).
 
shared_ptr cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
 Creates a shared_ptr clone of the factor with a new noise model.
 
- Public Member Functions inherited from gtsam::NonlinearFactor
 NonlinearFactor ()
 Default constructor for I/O only.
 
template<typename CONTAINER >
 NonlinearFactor (const CONTAINER &keys)
 Constructor from a collection of the keys involved in this factor.
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 print
 
virtual ~NonlinearFactor ()
 Destructor.
 
double error (const HybridValues &c) const override
 All factor types need to implement an error function.
 
virtual bool active (const Values &) const
 Checks whether a factor should be used based on a set of values.
 
virtual shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 Creates a shared_ptr clone of the factor with different keys using a map from old->new keys.
 
virtual shared_ptr rekey (const KeyVector &new_keys) const
 Clones a factor and fully replaces its keys.
 
virtual bool sendable () const
 Should the factor be evaluated in the same thread as the caller This is to enable factors that has shared states (like the Python GIL lock)
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor.
 
bool empty () const
 Whether the factor is empty (involves zero variables).
 
Key front () const
 First key.
 
Key back () const
 Last key.
 
const_iterator find (Key key) const
 find
 
const KeyVectorkeys () const
 Access the factor's involved variable keys.
 
const_iterator begin () const
 Iterator at beginning of involved variable keys.
 
const_iterator end () const
 Iterator at end of involved variable keys.
 
size_t size () const
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys
 
bool equals (const This &other, double tol=1e-9) const
 check equality
 
KeyVectorkeys ()
 
iterator begin ()
 Iterator at beginning of involved variable keys.
 
iterator end ()
 Iterator at end of involved variable keys.
 

Public Types

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

Friends

class boost::serialization::access
 Serialization function.
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactorN< Pose3, double >
using Base = NoiseModelFactor
 
using This = NoiseModelFactorN< ValueTypes... >
 
using OptionalMatrix = boost::optional< Matrix & >
 
using KeyType = Key
 
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 >
 
- 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)
 Constructor - only for subclasses, as this does not set keys.
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 Default constructor for I/O.
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 Construct factor from container of keys.
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys.
 
- Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor FromKeys (const CONTAINER &keys)
 Construct factor from container of keys.
 
template<typename ITERATOR >
static Factor FromIterators (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys.
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor.
 

Constructor & Destructor Documentation

◆ BarometricFactor()

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

Member Function Documentation

◆ clone()

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

Reimplemented from gtsam::NonlinearFactor.

◆ equals()

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

equals

Reimplemented from gtsam::NonlinearFactor.

◆ print()

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

print

Reimplemented from gtsam::Factor.


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