Camera tracking: moved camera solver into it's own job
[blender-staging.git] / extern / libmv / libmv / simple_pipeline / pipeline.h
1 // Copyright (c) 2011 libmv authors.
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to
5 // deal in the Software without restriction, including without limitation the
6 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 // sell copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19 // IN THE SOFTWARE.
20
21 #ifndef LIBMV_SIMPLE_PIPELINE_PIPELINE_H_
22 #define LIBMV_SIMPLE_PIPELINE_PIPELINE_H_
23
24 #include "libmv/simple_pipeline/callbacks.h"
25 #include "libmv/simple_pipeline/tracks.h"
26 #include "libmv/simple_pipeline/reconstruction.h"
27
28 namespace libmv {
29
30 /*!
31     Estimate camera poses and scene 3D coordinates for all frames and tracks.
32
33     This method should be used once there is an initial reconstruction in
34     place, for example by reconstructing from two frames that have a sufficient
35     baseline and number of tracks in common. This function iteratively
36     triangulates points that are visible by cameras that have their pose
37     estimated, then resections (i.e. estimates the pose) of cameras that are
38     not estimated yet that can see triangulated points. This process is
39     repeated until all points and cameras are estimated. Periodically, bundle
40     adjustment is run to ensure a quality reconstruction.
41
42     \a tracks should contain markers used in the reconstruction.
43     \a reconstruction should contain at least some 3D points or some estimated
44     cameras. The minimum number of cameras is two (with no 3D points) and the
45     minimum number of 3D points (with no estimated cameras) is 5.
46
47     \sa EuclideanResect, EuclideanIntersect, EuclideanBundle
48 */
49 void EuclideanCompleteReconstruction(const Tracks &tracks,
50                                      EuclideanReconstruction *reconstruction,
51                                      ProgressUpdateCallback *update_callback = NULL);
52
53 /*!
54     Estimate camera matrices and homogeneous 3D coordinates for all frames and
55     tracks.
56
57     This method should be used once there is an initial reconstruction in
58     place, for example by reconstructing from two frames that have a sufficient
59     baseline and number of tracks in common. This function iteratively
60     triangulates points that are visible by cameras that have their pose
61     estimated, then resections (i.e. estimates the pose) of cameras that are
62     not estimated yet that can see triangulated points. This process is
63     repeated until all points and cameras are estimated. Periodically, bundle
64     adjustment is run to ensure a quality reconstruction.
65
66     \a tracks should contain markers used in the reconstruction.
67     \a reconstruction should contain at least some 3D points or some estimated
68     cameras. The minimum number of cameras is two (with no 3D points) and the
69     minimum number of 3D points (with no estimated cameras) is 5.
70
71     \sa ProjectiveResect, ProjectiveIntersect, ProjectiveBundle
72 */
73 void ProjectiveCompleteReconstruction(const Tracks &tracks,
74                                       ProjectiveReconstruction *reconstruction);
75
76
77 class CameraIntrinsics;
78
79 // TODO(keir): Decide if we want these in the public API, and if so, what the
80 // appropriate include file is.
81
82 double EuclideanReprojectionError(const Tracks &image_tracks,
83                                   const EuclideanReconstruction &reconstruction,
84                                   const CameraIntrinsics &intrinsics);
85
86 double ProjectiveReprojectionError(
87     const Tracks &image_tracks,
88     const ProjectiveReconstruction &reconstruction,
89     const CameraIntrinsics &intrinsics);
90
91 void InvertIntrinsicsForTracks(const Tracks &raw_tracks,
92                                const CameraIntrinsics &camera_intrinsics,
93                                Tracks *calibrated_tracks);
94
95 }  // namespace libmv
96
97 #endif  // LIBMV_SIMPLE_PIPELINE_PIPELINE_H_