pcl_base.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Point Cloud Library (PCL) - www.pointclouds.org
 *  Copyright (c) 2010-2011, Willow Garage, 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 Willow Garage, Inc. 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: pcl_base.h 3771 2012-01-01 06:58:14Z rusu $
 *
 */
#ifndef PCL_PCL_BASE_H_
#define PCL_PCL_BASE_H_

#include <cstddef>
// Eigen includes
#include <Eigen/StdVector>
// STD includes
#include <vector>

// Include PCL macros such as PCL_ERROR, etc
#include "pcl/pcl_macros.h"

// Boost includes. Needed everywhere.
#include <boost/shared_ptr.hpp>

// Point Cloud message includes. Needed everywhere.
#include <sensor_msgs/PointCloud2.h>
#include "pcl/point_cloud.h"
#include "pcl/PointIndices.h"
#include <pcl/pcl_macros.h>

#include <pcl/console/print.h>

namespace pcl
{
  // definitions used everywhere
  typedef boost::shared_ptr <std::vector<int> > IndicesPtr;
  typedef boost::shared_ptr <const std::vector<int> > IndicesConstPtr;


  template <typename PointT>
  class PCLBase
  {
    public:
      typedef pcl::PointCloud<PointT> PointCloud;
      typedef typename PointCloud::Ptr PointCloudPtr;
      typedef typename PointCloud::ConstPtr PointCloudConstPtr;

      typedef PointIndices::Ptr PointIndicesPtr;
      typedef PointIndices::ConstPtr PointIndicesConstPtr;

      PCLBase () : input_ (), indices_ (), use_indices_ (false), fake_indices_ (false) {}
      
      PCLBase (const PCLBase& base)
        : input_ (base.input_)
        , indices_ (base.indices_)
        , use_indices_ (base.use_indices_)
        , fake_indices_ (base.fake_indices_)
      {}

      virtual ~PCLBase() 
      {
        input_.reset ();
        indices_.reset ();
      }
      
      virtual inline void 
      setInputCloud (const PointCloudConstPtr &cloud) { input_ = cloud; }

      inline PointCloudConstPtr const 
      getInputCloud () { return (input_); }

      inline void
      setIndices (const IndicesPtr &indices)
      {
        indices_ = indices;
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline void
      setIndices (const IndicesConstPtr &indices)
      {
        indices_.reset (new std::vector<int> (*indices));
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline void
      setIndices (const PointIndicesConstPtr &indices)
      {
        indices_.reset (new std::vector<int> (indices->indices));
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline void 
      setIndices (size_t row_start, size_t col_start, size_t nb_rows, size_t nb_cols)
      {
        if ((nb_rows > input_->height) || (row_start > input_->height))
        {
          PCL_ERROR ("[PCLBase::setIndices] cloud is only %d height", input_->height);
          return;
        }

        if ((nb_cols > input_->width) || (col_start > input_->width))
        {
          PCL_ERROR ("[PCLBase::setIndices] cloud is only %d width", input_->width);
          return;
        }

        size_t row_end = row_start + nb_rows;
        if (row_end > input_->height)
        {
          PCL_ERROR ("[PCLBase::setIndices] %d is out of rows range %d", row_end, input_->height);
          return;
        }

        size_t col_end = col_start + nb_cols;
        if (col_end > input_->width)
        {
          PCL_ERROR ("[PCLBase::setIndices] %d is out of columns range %d", col_end, input_->width);
          return;
        }

        indices_.reset (new std::vector<int>);
        indices_->reserve (nb_cols * nb_rows);
        for(size_t i = row_start; i < row_end; i++)
          for(size_t j = col_start; j < col_end; j++)
            indices_->push_back ((i * input_->width) + j);
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline IndicesPtr const 
      getIndices () { return (indices_); }

      const PointT& operator[] (size_t pos)
      {
        return ((*input_)[(*indices_)[pos]]);
      }

    protected:
      PointCloudConstPtr input_;

      IndicesPtr indices_;

      bool use_indices_;

      bool fake_indices_;

      inline bool
      initCompute ()
      {
        // Check if input was set
        if (!input_)
          return (false);

        // If no point indices have been given, construct a set of indices for the entire input point cloud
        if (!indices_)
        {
          fake_indices_ = true;
          indices_.reset (new std::vector<int>);
          try
          {
            indices_->resize (input_->points.size ());
          }
          catch (std::bad_alloc)
          {
            PCL_ERROR ("[initCompute] Failed to allocate %lu indices.\n", (unsigned long)input_->points.size ());
          }
          for (size_t i = 0; i < indices_->size (); ++i) { (*indices_)[i] = (int) i; }
        }

        // If we have a set of fake indices, but they do not match the number of points in the cloud, update them
        if (fake_indices_ && indices_->size () != input_->points.size ())
        {
          size_t indices_size = indices_->size ();
          indices_->resize (input_->points.size ());
          for (size_t i = indices_size; i < indices_->size (); ++i) { (*indices_)[i] = (int) i; }
        }

        return (true);
      }

      inline bool
      deinitCompute ()
      {
        return (true);
      }
    public:
      EIGEN_MAKE_ALIGNED_OPERATOR_NEW
  };

  template <>
  class PCL_EXPORTS PCLBase<sensor_msgs::PointCloud2>
  {
    public:
      typedef sensor_msgs::PointCloud2 PointCloud2;
      typedef PointCloud2::Ptr PointCloud2Ptr;
      typedef PointCloud2::ConstPtr PointCloud2ConstPtr;

      typedef PointIndices::Ptr PointIndicesPtr;
      typedef PointIndices::ConstPtr PointIndicesConstPtr;

      PCLBase () : input_ (), indices_ (), use_indices_ (false), fake_indices_ (false),
                   x_field_name_ ("x"), y_field_name_ ("y"), z_field_name_ ("z")
      {};

      virtual ~PCLBase() 
      {
        input_.reset ();
        indices_.reset ();
      }

      void 
      setInputCloud (const PointCloud2ConstPtr &cloud);

      inline PointCloud2ConstPtr const 
      getInputCloud () { return (input_); }

      inline void
      setIndices (const IndicesPtr &indices)
      {
        indices_ = indices;
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline void
      setIndices (const PointIndicesConstPtr &indices)
      {
        indices_.reset (new std::vector<int> (indices->indices));
        fake_indices_ = false;
        use_indices_  = true;
      }

      inline IndicesPtr const 
      getIndices () { return (indices_); }

    protected:
      PointCloud2ConstPtr input_;

      IndicesPtr indices_;

      bool use_indices_;

      bool fake_indices_;

      std::vector<int> field_sizes_;

      int x_idx_, y_idx_, z_idx_;

      std::string x_field_name_, y_field_name_, z_field_name_;

      bool initCompute ();
      bool deinitCompute ();
    public:
      EIGEN_MAKE_ALIGNED_OPERATOR_NEW
  };
}

#endif  //#ifndef PCL_PCL_BASE_H_