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

Three unknowns: the pose, the camera offset, and the camera calibration. Landmark is constant. This is intended to be used for camera calibration. More...

#include <PlanarProjectionFactor.h>

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

Public Types

typedef NoiseModelFactorN< Pose2, Pose3, Cal3DS2Base
 
- Public Types inherited from gtsam::NoiseModelFactorN< Pose2, Pose3, Cal3DS2 >
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

NonlinearFactor::shared_ptr clone () const override
 
Vector evaluateError (const Pose2 &wTb, const Pose3 &bTc, const Cal3DS2 &calib, OptionalMatrixType HwTb, OptionalMatrixType HbTc, OptionalMatrixType Hcalib) const override
 
 PlanarProjectionFactor3 ()
 
 PlanarProjectionFactor3 (Key poseKey, Key offsetKey, Key calibKey, const Point3 &landmark, const Point2 &measured, const SharedNoiseModel &model={})
 constructor for variable pose, offset, and calibration, known landmark. More...
 
 ~PlanarProjectionFactor3 () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactorN< Pose2, Pose3, Cal3DS2 >
Key key () const
 
virtual Vector unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const =0
 
Vector unwhitenedError (const Values &x, std::vector< Matrix > &H) 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 Attributes

Point3 landmark_
 

Additional Inherited Members

- Static Public Attributes inherited from gtsam::NoiseModelFactorN< Pose2, Pose3, Cal3DS2 >
constexpr static auto N
 N is the number of variables (N-way factor) More...
 
- Protected Types inherited from gtsam::NoiseModelFactorN< Pose2, Pose3, Cal3DS2 >
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::PlanarProjectionFactorBase
 PlanarProjectionFactorBase ()
 
 PlanarProjectionFactorBase (const Point2 &measured)
 
Point2 predict (const Point3 &landmark, const Pose2 &wTb, const Pose3 &bTc, const Cal3DS2 &calib, OptionalJacobian< 2, 3 > Hlandmark={}, OptionalJacobian< 2, 3 > HwTb={}, OptionalJacobian< 2, 6 > HbTc={}, OptionalJacobian< 2, 9 > Hcalib={}) const
 
- 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::PlanarProjectionFactorBase
Point2 measured_
 
- 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

Three unknowns: the pose, the camera offset, and the camera calibration. Landmark is constant. This is intended to be used for camera calibration.

Definition at line 237 of file PlanarProjectionFactor.h.

Member Typedef Documentation

◆ Base

Definition at line 239 of file PlanarProjectionFactor.h.

Constructor & Destructor Documentation

◆ PlanarProjectionFactor3() [1/2]

gtsam::PlanarProjectionFactor3::PlanarProjectionFactor3 ( )
inline

Definition at line 242 of file PlanarProjectionFactor.h.

◆ ~PlanarProjectionFactor3()

gtsam::PlanarProjectionFactor3::~PlanarProjectionFactor3 ( )
inlineoverride

Definition at line 244 of file PlanarProjectionFactor.h.

◆ PlanarProjectionFactor3() [2/2]

gtsam::PlanarProjectionFactor3::PlanarProjectionFactor3 ( Key  poseKey,
Key  offsetKey,
Key  calibKey,
const Point3 landmark,
const Point2 measured,
const SharedNoiseModel model = {} 
)
inline

constructor for variable pose, offset, and calibration, known landmark.

Parameters
poseKeyindex of the robot pose2 in the z=0 plane
offsetKeyindex of camera offset from pose
calibKeyindex of camera calibration
landmarkpoint3 in the world
measuredcorresponding point2 in the camera frame
modelstddev of the measurements, ~one pixel?

Definition at line 261 of file PlanarProjectionFactor.h.

Member Function Documentation

◆ clone()

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

Reimplemented from gtsam::NonlinearFactor.

Definition at line 247 of file PlanarProjectionFactor.h.

◆ evaluateError()

Vector gtsam::PlanarProjectionFactor3::evaluateError ( const Pose2 wTb,
const Pose3 bTc,
const Cal3DS2 calib,
OptionalMatrixType  HwTb,
OptionalMatrixType  HbTc,
OptionalMatrixType  Hcalib 
) const
inlineoverride
Parameters
wTb"world to body": estimated pose2
bTc"body to camera": pose3 offset from pose2 +x
calibcalibration
HwTbpose jacobian
HbTcoffset jacobian
Hcalibcalibration jacobian

Definition at line 280 of file PlanarProjectionFactor.h.

Member Data Documentation

◆ landmark_

Point3 gtsam::PlanarProjectionFactor3::landmark_
private

Definition at line 291 of file PlanarProjectionFactor.h.


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


gtsam
Author(s):
autogenerated on Wed Jan 1 2025 04:14:37