starter/starter.h

   1 /*
   2 Copyright 2005, 2006 Computer Vision Lab,
   3 Ecole Polytechnique Federale de Lausanne (EPFL), Switzerland.
   4 All rights reserved.
   5
   6 This file is part of BazAR.
   7
   8 BazAR is free software; you can redistribute it and/or modify it under the
   9 terms of the GNU General Public License as published by the Free Software
  10 Foundation; either version 2 of the License, or (at your option) any later
  11 version.
  12
  13 BazAR is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  15 PARTICULAR PURPOSE. See the GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License along with
  18 BazAR; if not, write to the Free Software Foundation, Inc., 51 Franklin
  19 Street, Fifth Floor, Boston, MA 02110-1301, USA
  20 */
  21 #ifndef STARTER_H
  22 #define STARTER_H
  23
  24 /*!\mainpage
  25
  26   \section intro Introduction
  27
  28   Bazar is a computer vision library based on feature points detection and
  29   matching. In particular, it is able to quickly detect and register known
  30   planar objects in images. It also contains a powerfull geometric and
  31   photometric camera calibration system.
  32
  33   It is written and distributed at CVLab, EPFL -- http://cvlab.epfl.ch/
  34
  35   \section install Installing Bazar
  36
  37   BazAR depends on OpenCV (http://opencvlibrary.sourceforge.net/). You will
  38   need to install it before using BazAR. For OpenGL support, GLUT and GLEW are
  39   required (http://www.opengl.org/resources/libraries/glut/ and http://glew.sourceforge.net/).
  40
  41   \subsection unix_install UNIX/Linux
  42
  43   Download bazar-xx.tar.gz. Run:
  44   tar -xzf bazar-xx.tar.gz
  45   cd bazar-xx
  46   ./configure
  47   make
  48
  49   \subsection windows_install Windows
  50
  51   Download the windows archive, run setup.exe and follow intructions.
  52
  53   \section orga Library Organization
  54
  55   Bazar is made of several modules, implemented in two libraries:
  56   - \ref garfeild
  57   - \ref starter
  58
  59   \section Examples
  60
  61   \example filedetect.cpp
  62   This example shows how to train and use a planar object detector
  63
  64   \example singlecalib.cpp
  65   This interactive example shows how compute the geometric calibration of a
  66   single camera.
  67
  68   \example augment3d.cpp
  69   When calibration is done, this example shows how basic 3D augmentation works.
  70
  71   \example fullcalib.cpp
  72   This is a more complete example that computes geometric and photometric
  73   calibration and augmentation with a single camera.
  74
  75   \example multicam.cpp
  76   A multi camera geometric and photmetric calibration example which depends
  77   only on OpenCV.
  78
  79   \example multigl.cpp
  80   A multi camera geometric and photometric calibration example, with OpenGL
  81   augmentation.
  82 */
  83
  84 /*! \defgroup starter Starter: Basic structures and mathematical tools
  85
  86   Starter contains basic structures and mathematical tools, like a non-linear
  87   minimizer (ls_minimizer).
  88  */
  89 #include <general/general.h>
  90
  91 #include <math/linear_algebra.h>
  92 #include <math/linear_systems.h>
  93 #include <math/mcvm.h>
  94 #include <math/robust_estimators.h>
  95
  96 #include <geometry/affinity.h>
  97 #include <geometry/homography.h>
  98 #include <geometry/projection_matrix.h>
  99
 100 #include <image/mcv.h>
 101 #include <image/pyrimage.h>
 102
 103 #include <optimization/ls_minimizer2.h>
 104
 105 #endif // STARTER_H