#include <LossFunctions.h>
Public Types | |
| typedef std::shared_ptr< GemanMcClure > | shared_ptr |
 Public Types inherited from gtsam::noiseModel::mEstimator::Base | |
| enum | ReweightScheme { Scalar, Block } |
| typedef std::shared_ptr< Base > | shared_ptr |
Public Member Functions | |
| bool | equals (const Base &expected, double tol=1e-8) const override |
| GemanMcClure (double c=1.0, const ReweightScheme reweight=Block) | |
| double | loss (double distance) const override |
| double | modelParameter () const |
| void | print (const std::string &s) const override |
| double | weight (double distance) const override |
| ~GemanMcClure () override | |
| Public Member Functions inherited from gtsam::noiseModel::mEstimator::Base | |
| Base (const ReweightScheme reweight=Block) | |
| void | reweight (Vector &error) const |
| void | reweight (std::vector< Matrix > &A, Vector &error) const |
| void | reweight (Matrix &A, Vector &error) const |
| void | reweight (Matrix &A1, Matrix &A2, Vector &error) const |
| void | reweight (Matrix &A1, Matrix &A2, Matrix &A3, Vector &error) const |
| ReweightScheme | reweightScheme () const |
| Returns the reweight scheme, as explained in ReweightScheme. More... | |
| double | sqrtWeight (double distance) const |
| Vector | sqrtWeight (const Vector &error) const |
| Vector | weight (const Vector &error) const |
| virtual | ~Base () |
Static Public Member Functions | |
| static shared_ptr | Create (double k, const ReweightScheme reweight=Block) |
Protected Attributes | |
| double | c_ |
| Protected Attributes inherited from gtsam::noiseModel::mEstimator::Base | |
| ReweightScheme | reweight_ |
| Strategy for reweighting. More... | |
Detailed Description
Implementation of the "Geman-McClure" robust error model (Zhang97ivc).
Note that Geman-McClure weight function uses the parameter c == 1.0, but here it's allowed to use different values, so we actually have the generalized Geman-McClure from (Agarwal15phd).
- Loss (x) = 0.5 (c²x²)/(c²+x²)
- Derivative (x) = xc⁴/(c²+x²)²
- Weight w(x) = (x)/x = c⁴/(c²+x²)²
Definition at line 365 of file LossFunctions.h.
Member Typedef Documentation
◆ shared_ptr
| typedef std::shared_ptr<GemanMcClure> gtsam::noiseModel::mEstimator::GemanMcClure::shared_ptr |
Definition at line 367 of file LossFunctions.h.
Constructor & Destructor Documentation
◆ GemanMcClure()
| gtsam::noiseModel::mEstimator::GemanMcClure::GemanMcClure | ( | double | c = 1.0, |
| const ReweightScheme | reweight = Block |
||
| ) |
Definition at line 315 of file LossFunctions.cpp.
◆ ~GemanMcClure()
|
inlineoverride |
Definition at line 370 of file LossFunctions.h.
Member Function Documentation
◆ Create()
|
static |
Definition at line 342 of file LossFunctions.cpp.
◆ equals()
|
overridevirtual |
Implements gtsam::noiseModel::mEstimator::Base.
Definition at line 336 of file LossFunctions.cpp.
◆ loss()
|
overridevirtual |
This method is responsible for returning the total penalty for a given amount of error. For example, this method is responsible for implementing the quadratic function for an L2 penalty, the absolute value function for an L1 penalty, etc.
TODO(mikebosse): When the loss function has as input the norm of the error vector, then it prevents implementations of asymmeric loss functions. It would be better for this function to accept the vector and internally call the norm if necessary.
This returns (x) in mEstimator
Reimplemented from gtsam::noiseModel::mEstimator::Base.
Definition at line 326 of file LossFunctions.cpp.
◆ modelParameter()
|
inline |
Definition at line 376 of file LossFunctions.h.
◆ print()
|
overridevirtual |
Implements gtsam::noiseModel::mEstimator::Base.
Definition at line 332 of file LossFunctions.cpp.
◆ weight()
|
overridevirtual |
This method is responsible for returning the weight function for a given amount of error. The weight function is related to the analytic derivative of the loss function. See https://members.loria.fr/MOBerger/Enseignement/Master2/Documents/ZhangIVC-97-01.pdf for details. This method is required when optimizing cost functions with robust penalties using iteratively re-weighted least squares.
This returns w(x) in mEstimator
Implements gtsam::noiseModel::mEstimator::Base.
Definition at line 319 of file LossFunctions.cpp.
Member Data Documentation
◆ c_
|
protected |
Definition at line 379 of file LossFunctions.h.
The documentation for this class was generated from the following files: