OKVIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ErrorInterface.hpp
Go to the documentation of this file.
1 /*********************************************************************************
2  * OKVIS - Open Keyframe-based Visual-Inertial SLAM
3  * Copyright (c) 2015, Autonomous Systems Lab / ETH Zurich
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of Autonomous Systems Lab / ETH Zurich nor the names of
14  * its contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Created on: Sep 12, 2013
30  * Author: Stefan Leutenegger (s.leutenegger@imperial.ac.uk)
31  *********************************************************************************/
32 
40 #ifndef INCLUDE_OKVIS_CERES_ERRORINTERFACE_HPP_
41 #define INCLUDE_OKVIS_CERES_ERRORINTERFACE_HPP_
42 
43 #include <vector>
44 #include <Eigen/Core>
45 #include <okvis/assert_macros.hpp>
46 
48 namespace okvis {
50 namespace ceres {
51 
54  public:
55  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
56  OKVIS_DEFINE_EXCEPTION(Exception, std::runtime_error)
57 
58 
60  }
62  virtual ~ErrorInterface() {
63  }
64 
67 
70  virtual size_t residualDim() const = 0;
71 
74  virtual size_t parameterBlocks() const = 0;
75 
81  virtual size_t parameterBlockDim(size_t parameterBlockId) const = 0;
82 
84  // Error and Jacobian computation
94  virtual bool EvaluateWithMinimalJacobians(
95  double const* const * parameters, double* residuals, double** jacobians,
96  double** jacobiansMinimal) const = 0;
97 
99  virtual std::string typeInfo() const = 0;
100 };
101 
102 } // namespace ceres
103 } // namespace okvis
104 
105 #endif /* INCLUDE_OKVIS_CERES_ERRORINTERFACE_HPP_ */
virtual size_t residualDim() const =0
Get dimension of residuals.
virtual size_t parameterBlocks() const =0
Get the number of parameter blocks this is connected to.
virtual size_t parameterBlockDim(size_t parameterBlockId) const =0
get the dimension of a parameter block this is connected to.
Simple interface class the errors implemented here should inherit from.
Definition: ErrorInterface.hpp:53
#define OKVIS_DEFINE_EXCEPTION(exceptionName, exceptionParent)
Macro for defining an exception with a given parent.
Definition: assert_macros.hpp:52
This file contains some useful assert macros.
virtual std::string typeInfo() const =0
Residual block type as string.
virtual bool EvaluateWithMinimalJacobians(double const *const *parameters, double *residuals, double **jacobians, double **jacobiansMinimal) const =0
This evaluates the error term and additionally computes the Jacobians in the minimal internal represe...
virtual ~ErrorInterface()
Destructor (does nothing).
Definition: ErrorInterface.hpp:62