Loading...
Searching...
No Matches
gtsam::RangeFactor< A1, A2, T > Class Template Reference
Detailed Description
template<typename A1, typename A2 = A1, typename T = double>
class gtsam::RangeFactor< A1, A2, T >
class gtsam::RangeFactor< A1, A2, T >
Binary factor for a range measurement Works for any two types A1,A2 for which the functor Range<A1,A2>() is defined.
Inheritance diagram for gtsam::RangeFactor< A1, A2, T >:
Public Member Functions | |
| RangeFactor ()=default | |
| default constructor | |
| RangeFactor (Key key1, Key key2, T measured, const SharedNoiseModel &model) | |
| Construct from keys, a range measurement, and a noise model. | |
| gtsam::NonlinearFactor::shared_ptr | clone () const override |
| const T & | measured () const |
| ErrorVector | evaluateError (const A1 &a1, const A2 &a2, OptionalMatrixType H1=OptionalNone, OptionalMatrixType H2=OptionalNone) const override |
| Evaluate the unwhitened range error and optional Jacobians. | |
| void | print (const std::string &s="", const KeyFormatter &kf=DefaultKeyFormatter) const override |
| print | |
| bool | equals (const NonlinearFactor &f, double tol) const override |
| Check equality up to a tolerance. | |
| Public Member Functions inherited from gtsam::NoiseModelFactorT< traits< double >::TangentVector, A1, A1 > | |
| Vector | unwhitenedError (const Values &x, std::vector< Matrix > &H) const |
| support taking in the actual vector instead of the pointer as well to get access to this version of the function from derived classes one will need to use the "using" keyword and specify that like this: public: using NoiseModelFactor::unwhitenedError; | |
| Key | key () const |
| Returns a key. | |
| NoiseModelFactorT () | |
| Default Constructor for I/O. | |
| virtual traits< double >::TangentVector | evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0 |
| Override evaluateError to finish implementing an n-way factor. | |
| Key | key1 () const |
| Key | key2 () const |
| Key | key3 () const |
| Key | key4 () const |
| Key | key5 () const |
| Key | key6 () const |
| std::shared_ptr< GaussianFactor > | linearize (const Values &values) const override |
| Linearize factors whose error and argument dimensions are all fixed to an arbitrary-arity FixedJacobianFactor. | |
| 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. | |
| size_t | dim () const override |
| get the dimension of the factor (number of rows on linearization) | |
| const SharedNoiseModel & | noiseModel () const |
| access to the noise model | |
| virtual Vector | unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const =0 |
| Error function without the NoiseModel, \( z-h(x) \). | |
| Vector | unwhitenedError (const Values &x, std::vector< Matrix > &H) const |
| support taking in the actual vector instead of the pointer as well to get access to this version of the function from derived classes one will need to use the "using" keyword and specify that like this: public: using NoiseModelFactor::unwhitenedError; | |
| 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. | |
| shared_ptr | cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const |
| Creates a shared_ptr clone of the factor with a new noise model. | |
| double | error (const HybridValues &c) const override |
| All factor types need to implement an error function. | |
| 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. | |
| double | error (const HybridValues &c) const override |
| All factor types need to implement an error function. | |
| virtual bool | active (const Values &c) const |
| Checks whether a factor should be used based on a set of values. | |
| virtual void | qcqpFactors (NonlinearFactorGraph *costs, NonlinearEqualityConstraints *constraints, size_t columnDimension=1) const |
| Add this factor's QCQP cost and constraints over matrix-valued QCQP variables with the given column dimension. | |
| 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 KeyVector & | keys () 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 | |
| KeyVector & | keys () |
| iterator | begin () |
| Iterator at beginning of involved variable keys. | |
| iterator | end () |
| Iterator at end of involved variable keys. | |
Additional Inherited Members | |
| Static Public Attributes inherited from gtsam::NoiseModelFactorT< traits< double >::TangentVector, A1, A1 > | |
| static constexpr auto | N |
| N is the number of variables (N-way factor). | |
| Public Types inherited from gtsam::NoiseModelFactorT< traits< double >::TangentVector, A1, A1 > | |
| using | ValueType |
| The type of the I'th template param can be obtained as ValueType. | |
| Public Types inherited from gtsam::NoiseModelFactor | |
| typedef std::shared_ptr< This > | shared_ptr |
| Noise model. | |
| Public Types inherited from gtsam::NonlinearFactor | |
| typedef std::shared_ptr< This > | shared_ptr |
| Public Types inherited from gtsam::Factor | |
| typedef KeyVector::iterator | iterator |
| Iterator over keys. | |
| typedef KeyVector::const_iterator | const_iterator |
| Const iterator over keys. | |
| Protected Types inherited from gtsam::NoiseModelFactorT< traits< double >::TangentVector, A1, A1 > | |
| using | Base |
| using | This |
| using | OptionalMatrixTypeT |
| using | KeyType |
| using | MatrixTypeT |
| using | IsConvertible |
| using | IndexIsValid |
| using | ContainerElementType |
| using | IsContainerOfKeys |
| using | AreAllMatrixRefs |
| A helper alias to check if a list of args are all references to a matrix or not. | |
| using | IsMatrixPointer |
| using | IsNullpointer |
| using | AreAllMatrixPtrs |
| A helper alias to check if a list of args are all pointers to a matrix or not. | |
| 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. | |
| 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. | |
| 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. | |
Member Function Documentation
◆ clone()
template<typename A1, typename A2 = A1, typename T = double>
|
inlineoverridevirtual |
- Returns
- a deep copy of this factor
Reimplemented from gtsam::NonlinearFactor.
◆ equals()
template<typename A1, typename A2 = A1, typename T = double>
|
inlineoverridevirtual |
Check equality up to a tolerance.
Reimplemented from gtsam::NoiseModelFactor.
◆ measured()
template<typename A1, typename A2 = A1, typename T = double>
|
inline |
- Returns
- the measurement
◆ print()
template<typename A1, typename A2 = A1, typename T = double>
|
inlineoverridevirtual |
Reimplemented from gtsam::NoiseModelFactor.
The documentation for this class was generated from the following file:
- /tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/sam/RangeFactor.h
