multiscale_feature_persistence.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Point Cloud Library (PCL) - www.pointclouds.org
 *  Copyright (c) 2011, Alexandru-Eugen Ichim
 *  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_MULTISCALE_FEATURE_PERSISTENCE_H_
#define PCL_MULTISCALE_FEATURE_PERSISTENCE_H_

#include <pcl/pcl_base.h>
#include <pcl/features/feature.h>
#include <pcl/point_representation.h>
#include <pcl/common/norms.h>
#include <list>

namespace pcl
{
  template <typename PointSource, typename PointFeature>
  class MultiscaleFeaturePersistence : public PCLBase<PointSource>
  {
    public:
      typedef boost::shared_ptr<MultiscaleFeaturePersistence<PointSource, PointFeature> > Ptr;
      typedef boost::shared_ptr<const MultiscaleFeaturePersistence<PointSource, PointFeature> > ConstPtr;
      typedef pcl::PointCloud<PointFeature> FeatureCloud;
      typedef typename pcl::PointCloud<PointFeature>::Ptr FeatureCloudPtr;
      typedef typename pcl::Feature<PointSource, PointFeature>::Ptr FeatureEstimatorPtr;
      typedef boost::shared_ptr<const pcl::PointRepresentation <PointFeature> > FeatureRepresentationConstPtr;

      using pcl::PCLBase<PointSource>::input_;

      MultiscaleFeaturePersistence ();
      
      virtual ~MultiscaleFeaturePersistence () {}

      void
      computeFeaturesAtAllScales ();

      void
      determinePersistentFeatures (FeatureCloud &output_features,
                                   boost::shared_ptr<std::vector<int> > &output_indices);

      inline void
      setScalesVector (std::vector<float> &scale_values) { scale_values_ = scale_values; }

      inline std::vector<float>
      getScalesVector () { return scale_values_; }

      inline void
      setFeatureEstimator (FeatureEstimatorPtr feature_estimator) { feature_estimator_ = feature_estimator; };

      inline FeatureEstimatorPtr
      getFeatureEstimator () { return feature_estimator_; }

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

      inline FeatureRepresentationConstPtr const
      getPointRepresentation () { return feature_representation_; }

      inline void
      setAlpha (float alpha) { alpha_ = alpha; }

      inline float
      getAlpha () { return alpha_; }

      inline void
      setDistanceMetric (NormType distance_metric) { distance_metric_ = distance_metric; }

      inline NormType
      getDistanceMetric () { return distance_metric_; }


    private:
      bool
      initCompute ();


      virtual void
      computeFeatureAtScale (float &scale,
                             FeatureCloudPtr &features);


      float
      distanceBetweenFeatures (const std::vector<float> &a,
                               const std::vector<float> &b);

      void
      calculateMeanFeature ();

      void
      extractUniqueFeatures ();


      std::vector<float> scale_values_;

      float alpha_;

      NormType distance_metric_;

      FeatureEstimatorPtr feature_estimator_;

      std::vector<FeatureCloudPtr> features_at_scale_;
      std::vector<std::vector<std::vector<float> > > features_at_scale_vectorized_;
      std::vector<float> mean_feature_;
      FeatureRepresentationConstPtr feature_representation_;

      std::vector<std::list<size_t> > unique_features_indices_;
      std::vector<std::vector<bool> > unique_features_table_;
  };
}

#ifdef PCL_NO_PRECOMPILE
#include <pcl/features/impl/multiscale_feature_persistence.hpp>
#endif

#endif /* PCL_MULTISCALE_FEATURE_PERSISTENCE_H_ */