octree_container.h

/*
 * 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: octree_nodes.h 5596 2012-04-17 15:09:31Z jkammerl $
 */
 
#pragma once
 
#include <pcl/console/print.h>
#include <pcl/types.h>
 
#include <cassert>
#include <cstddef>
#include <vector>
 
namespace pcl {
namespace octree {
 
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** \brief @b Octree container class that can serve as a base to construct own leaf node
 * container classes.
 * \author Julius Kammerl (julius@kammerl.de)
 */
class OctreeContainerBase {
public:
  virtual ~OctreeContainerBase() = default;
 
  /** \brief Equal comparison operator
   */
  virtual bool
  operator==(const OctreeContainerBase&) const
  {
    return false;
  }
 
  /** \brief Inequal comparison operator
   * \param[in] other OctreeContainerBase to compare with
   */
  bool
  operator!=(const OctreeContainerBase& other) const
  {
    return (!operator==(other));
  }
 
  /** \brief Pure abstract method to get size of container (number of indices)
   * \return number of points/indices stored in leaf node container.
   */
  virtual uindex_t
  getSize() const
  {
    return 0u;
  }
 
  /** \brief Pure abstract reset leaf node implementation. */
  virtual void
  reset() = 0;
 
  /** \brief Empty addPointIndex implementation. This leaf node does not store any point
   * indices.
   */
  virtual void
  addPointIndex(index_t)
  {}
 
  /** \brief Empty getPointIndex implementation as this leaf node does not store any
   * point indices.
   */
  void
  getPointIndex(index_t&) const
  {}
 
  /** \brief Empty getPointIndex implementation as this leaf node does not store any
   * point indices.
   */
  virtual index_t
  getPointIndex() const
  {
    assert("getPointIndex: undefined point index");
    return -1;
  }
 
  /** \brief Empty getPointIndices implementation as this leaf node does not store any
   * data. \
   */
  virtual void
  getPointIndices(Indices&) const
  {}
};
 
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** \brief @b Octree container class that does not store any information.
 * \note Can be used for occupancy trees that are used for checking only the existence
 * of leaf nodes in the tree
 * \author Julius Kammerl (julius@kammerl.de)
 */
 
class OctreeContainerEmpty : public OctreeContainerBase {
public:
  /** \brief Octree deep copy method */
  virtual OctreeContainerEmpty*
  deepCopy() const
  {
    return (new OctreeContainerEmpty(*this));
  }
 
  /** \brief Abstract get size of container (number of DataT objects)
   * \return number of DataT elements in leaf node container.
   */
  uindex_t
  getSize() const override
  {
    return 0;
  }
 
  /** \brief Abstract reset leaf node implementation. */
  void
  reset() override
  {}
 
  /** \brief Empty addPointIndex implementation. This leaf node does not store any point
   * indices.
   */
  void
  addPointIndex(index_t) override
  {}
 
  /** \brief Empty getPointIndex implementation as this leaf node does not store any
   * point indices.
   */
  index_t
  getPointIndex() const override
  {
    PCL_ERROR(
        "[pcl::octree::OctreeContainerBase::getPointIndex] Undefined point index!\n");
    return -1;
  }
 
  /** \brief Empty getPointIndices implementation as this leaf node does not store any
   * data.
   */
  void
  getPointIndices(Indices&) const override
  {}
};
 
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** \brief @b Octree container class that does store a single point index.
 * \note Enables the octree to store a single DataT element within its leaf nodes.
 * \author Julius Kammerl (julius@kammerl.de)
 */
class OctreeContainerPointIndex : public OctreeContainerBase {
public:
  /** \brief Empty constructor. */
  OctreeContainerPointIndex() { reset(); }
 
  /** \brief Octree deep copy method */
  virtual OctreeContainerPointIndex*
  deepCopy() const
  {
    return (new OctreeContainerPointIndex(*this));
  }
 
  /** \brief Equal comparison operator
   * \param[in] other OctreeContainerBase to compare with
   */
  bool
  operator==(const OctreeContainerBase& other) const override
  {
    const auto* otherConDataT = dynamic_cast<const OctreeContainerPointIndex*>(&other);
 
    return (this->data_ == otherConDataT->data_);
  }
 
  /** \brief Add point index to container memory. This container stores a only a single
   * point index.
   * \param[in] data_arg index to be stored within leaf node.
   */
  void
  addPointIndex(index_t data_arg) override
  {
    data_ = data_arg;
  }
 
  /** \brief Retrieve point index from container. This container stores a only a single
   * point index
   * \return index stored within container.
   */
  index_t
  getPointIndex() const override
  {
    return data_;
  }
 
  /** \brief Retrieve point indices from container. This container stores only a single
   * point index
   * \param[out] data_vector_arg vector of point indices to be stored within
   * data vector
   */
  void
  getPointIndices(Indices& data_vector_arg) const override
  {
    if (data_ != static_cast<index_t>(-1))
      data_vector_arg.push_back(data_);
  }
 
  /** \brief Get size of container (number of DataT objects)
   * \return number of DataT elements in leaf node container.
   */
  uindex_t
  getSize() const override
  {
    return data_ == static_cast<index_t>(-1) ? 0 : 1;
  }
 
  /** \brief Reset leaf node memory to zero. */
  void
  reset() override
  {
    data_ = static_cast<index_t>(-1);
  }
 
protected:
  /** \brief Point index stored in octree. */
  index_t data_;
};
 
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** \brief @b Octree container class that does store a vector of point indices.
 * \note Enables the octree to store multiple DataT elements within its leaf nodes.
 * \author Julius Kammerl (julius@kammerl.de)
 */
class OctreeContainerPointIndices : public OctreeContainerBase {
public:
  /** \brief Octree deep copy method */
  virtual OctreeContainerPointIndices*
  deepCopy() const
  {
    return (new OctreeContainerPointIndices(*this));
  }
 
  /** \brief Equal comparison operator
   * \param[in] other OctreeContainerDataTVector to compare with
   */
  bool
  operator==(const OctreeContainerBase& other) const override
  {
    const auto* otherConDataTVec =
        dynamic_cast<const OctreeContainerPointIndices*>(&other);
 
    return (this->leafDataTVector_ == otherConDataTVec->leafDataTVector_);
  }
 
  /** \brief Add point index to container memory. This container stores a vector of
   * point indices.
   * \param[in] data_arg index to be stored within leaf node.
   */
  void
  addPointIndex(index_t data_arg) override
  {
    leafDataTVector_.push_back(data_arg);
  }
 
  /** \brief Retrieve point index from container. This container stores a vector of
   * point indices.
   * \return index stored within container.
   */
  index_t
  getPointIndex() const override
  {
    return leafDataTVector_.back();
  }
 
  /** \brief Retrieve point indices from container. This container stores a vector of
   * point indices.
   * \param[out] data_vector_arg vector of point indices to be stored
   * within data vector
   */
  void
  getPointIndices(Indices& data_vector_arg) const override
  {
    data_vector_arg.insert(
        data_vector_arg.end(), leafDataTVector_.begin(), leafDataTVector_.end());
  }
 
  /** \brief Retrieve reference to point indices vector. This container stores a vector
   * of point indices.
   * \return reference to vector of point indices to be stored within data vector
   */
  Indices&
  getPointIndicesVector()
  {
    return leafDataTVector_;
  }
 
  /** \brief Get size of container (number of indices)
   * \return number of point indices in container.
   */
  uindex_t
  getSize() const override
  {
    return static_cast<uindex_t>(leafDataTVector_.size());
  }
 
  /** \brief Reset leaf node. Clear DataT vector.*/
  void
  reset() override
  {
    leafDataTVector_.clear();
  }
 
protected:
  /** \brief Leaf node DataT vector. */
  Indices leafDataTVector_;
};
 
} // namespace octree
} // namespace pcl