internal/ceres/visibility.h

   1 // Ceres Solver - A fast non-linear least squares minimizer
   2 // Copyright 2015 Google Inc. All rights reserved.
   3 // http://ceres-solver.org/
   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 Google Inc. nor the names of its contributors may be
  14 //   used to endorse or promote products derived from this software without
  15 //   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 // Author: kushalav@google.com (Avanish Kushal)
  30 //         sameeragarwal@google.com (Sameer Agarwal)
  31 //
  32 // Functions to manipulate visibility information from the block
  33 // structure of sparse matrices.
  34
  35 #ifndef CERES_INTERNAL_VISIBILITY_H_
  36 #define CERES_INTERNAL_VISIBILITY_H_
  37
  38 #include <set>
  39 #include <vector>
  40 #include "ceres/graph.h"
  41
  42 namespace ceres {
  43 namespace internal {
  44
  45 struct CompressedRowBlockStructure;
  46
  47 // Given a compressed row block structure, computes the set of
  48 // e_blocks "visible" to each f_block. If an e_block co-occurs with an
  49 // f_block in a residual block, it is visible to the f_block. The
  50 // first num_eliminate_blocks columns blocks are e_blocks and the rest
  51 // f_blocks.
  52 //
  53 // In a structure from motion problem, e_blocks correspond to 3D
  54 // points and f_blocks correspond to cameras.
  55 void ComputeVisibility(const CompressedRowBlockStructure& block_structure,
  56                        int num_eliminate_blocks,
  57                        std::vector<std::set<int> >* visibility);
  58
  59 // Given f_block visibility as computed by the ComputeVisibility
  60 // function above, construct and return a graph whose vertices are
  61 // f_blocks and an edge connects two vertices if they have atleast one
  62 // e_block in common. The weight of this edge is normalized dot
  63 // product between the visibility vectors of the two
  64 // vertices/f_blocks.
  65 //
  66 // This graph reflects the sparsity structure of reduced camera
  67 // matrix/Schur complement matrix obtained by eliminating the e_blocks
  68 // from the normal equations.
  69 //
  70 // Caller acquires ownership of the returned WeightedGraph pointer
  71 // (heap-allocated).
  72 WeightedGraph<int>* CreateSchurComplementGraph(
  73     const std::vector<std::set<int> >& visibility);
  74
  75 }  // namespace internal
  76 }  // namespace ceres
  77
  78 #endif  // CERES_INTERNAL_VISIBILITY_H_