pyramid_feature_matching.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011, Alexandru-Eugen Ichim
 *                      Willow Garage, Inc
 *  Copyright (c) 2012-, Open Perception, Inc.
 *
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the copyright holder(s) nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id$
 *
 */

#ifndef PCL_PYRAMID_FEATURE_MATCHING_H_
#define PCL_PYRAMID_FEATURE_MATCHING_H_

#include <pcl/pcl_base.h>
#include <pcl/point_representation.h>

namespace pcl
{
  template <typename PointFeature>
  class PyramidFeatureHistogram : public PCLBase<PointFeature>
  {
    public:
      using PCLBase<PointFeature>::input_;

      typedef boost::shared_ptr<PyramidFeatureHistogram<PointFeature> > Ptr;
      typedef Ptr PyramidFeatureHistogramPtr;
      typedef boost::shared_ptr<const pcl::PointRepresentation<PointFeature> > FeatureRepresentationConstPtr;


      PyramidFeatureHistogram ();

      inline void
      setInputDimensionRange (std::vector<std::pair<float, float> > &dimension_range_input)
      { dimension_range_input_ = dimension_range_input; }

      inline std::vector<std::pair<float, float> >
      getInputDimensionRange () { return dimension_range_input_; }

      inline void
      setTargetDimensionRange (std::vector<std::pair<float, float> > &dimension_range_target)
      { dimension_range_target_ = dimension_range_target; }

      inline std::vector<std::pair<float, float> >
      getTargetDimensionRange () { return dimension_range_target_; }

      inline void
      setPointRepresentation (const FeatureRepresentationConstPtr& feature_representation) { feature_representation_ = feature_representation; }

      inline FeatureRepresentationConstPtr const
      getPointRepresentation () { return feature_representation_; }

      void
      compute ();

      inline bool
      isComputed () { return is_computed_; }

      static float
      comparePyramidFeatureHistograms (const PyramidFeatureHistogramPtr &pyramid_a,
                                       const PyramidFeatureHistogramPtr &pyramid_b);


    private:
      size_t nr_dimensions, nr_levels, nr_features;
      std::vector<std::pair<float, float> > dimension_range_input_, dimension_range_target_;
      FeatureRepresentationConstPtr feature_representation_;
      bool is_computed_;

      bool
      initializeHistogram ();

      void
      convertFeatureToVector (const PointFeature &feature,
                              std::vector<float> &feature_vector);

      void
      addFeature (std::vector<float> &feature);

      inline unsigned int&
      at (std::vector<size_t> &access,
          size_t &level);

      inline unsigned int&
      at (std::vector<float> &feature,
          size_t &level);

      struct PyramidFeatureHistogramLevel
      {
        PyramidFeatureHistogramLevel () :
          hist (), 
          bins_per_dimension (),
          bin_step ()
        {
        }

        PyramidFeatureHistogramLevel (std::vector<size_t> &a_bins_per_dimension, std::vector<float> &a_bin_step) : 
          hist (), 
          bins_per_dimension (a_bins_per_dimension),
          bin_step (a_bin_step)
        {
          initializeHistogramLevel ();
        }

        void
        initializeHistogramLevel ();

        std::vector<unsigned int> hist;
        std::vector<size_t> bins_per_dimension;
        std::vector<float> bin_step;
      };
      std::vector<PyramidFeatureHistogramLevel> hist_levels;
  };
}

#ifdef PCL_NO_PRECOMPILE
#include <pcl/registration/impl/pyramid_feature_matching.hpp>
#endif

#endif    // PCL_PYRAMID_FEATURE_MATCHING_H_