octree_iterator.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: octree_iterator.h 4702 2012-02-23 09:39:33Z gedikli $
 */

#ifndef OCTREE_ITERATOR_H
#define OCTREE_ITERATOR_H

#include <cstddef>
#include <vector>
#include <deque>

#include "octree_nodes.h"

#include <pcl/point_cloud.h>
#include <pcl/point_types.h>

#include <iterator>

namespace pcl
{
  namespace octree
  {

    template<typename DataT, typename LeafT, typename OctreeT>
      class OctreeIteratorBase : public std::iterator<std::forward_iterator_tag, const OctreeNode, void,
          const OctreeNode*, const OctreeNode&>
      {

      public:

        // public typedefs
        typedef typename OctreeT::OctreeBranch OctreeBranch;
        typedef typename OctreeT::OctreeKey OctreeKey;

        explicit
        OctreeIteratorBase (const OctreeT& octree_arg) :
            octree_ (octree_arg), currentNode_ (NULL)
        {
          reset ();
        }

        virtual
        ~OctreeIteratorBase ()
        {
        }

        inline void
        reset ()
        {
          // initialize iterator globals
          currentNode_ = (OctreeNode*)octree_.getRootNode ();
          currentOctreeDepth_ = 0;

          // reset octree key
          currentOctreeKey_.x = currentOctreeKey_.y = currentOctreeKey_.z = 0;
        }

        inline const OctreeKey&
        getCurrentOctreeKey () const
        {
          return (currentOctreeKey_);
        }

        inline unsigned int
        getCurrentOctreeDepth () const
        {
          return (currentOctreeDepth_);
        }

        inline const OctreeNode*
        getCurrentOctreeNode () const
        {
          return (currentNode_);
        }

        inline const OctreeNode*
        operator* () const
        { // return designated object
          return (this->getCurrentOctreeNode ());
        }

        inline bool
        isBranchNode () const
        {
          return (currentNode_->getNodeType () == BRANCH_NODE);
        }

        inline bool
        isLeafNode () const
        {
          return (currentNode_->getNodeType () == LEAF_NODE);
        }

        inline char
        getNodeConfiguration () const
        {
          char ret = 0;

          if (isBranchNode ())
          {

            // current node is a branch node
            const OctreeBranch* currentBranch = (const OctreeBranch*)this->currentNode_;

            // get child configuration bit pattern
            ret = octree_.getBranchBitPattern (*currentBranch);

          }

          return ret;
        }


        virtual void
        getData (const DataT*& data_arg) const
        {
          const DataT* result = 0;

          if (this->currentNode_ && (this->currentNode_->getNodeType () == LEAF_NODE))
          {
            const LeafT* leafNode = (const LeafT*)this->currentNode_;
            leafNode->getData (result);
          }
          data_arg = result;
        }

        virtual void
        getData (std::vector<DataT>& dataVector_arg) const
        {
          if (this->currentNode_ && (this->currentNode_->getNodeType () == LEAF_NODE))
          {
            const LeafT* leafNode = (const LeafT*)this->currentNode_;
            leafNode->getData (dataVector_arg);
          }
        }

        virtual unsigned long
        getNodeID () const
        {
          unsigned long id = 0;

          if (this->currentNode_)
          {
            // calculate integer id with respect to octree key
            unsigned int depth = octree_.getTreeDepth();
            id = currentOctreeKey_.x << (depth*2) |
                 currentOctreeKey_.y << (depth*1) |
                 currentOctreeKey_.z << (depth*0);
          }

          return id;
        }

      protected:
        const OctreeT& octree_;

        const OctreeNode* currentNode_;

        unsigned int currentOctreeDepth_;

        OctreeKey currentOctreeKey_;
      };


    template<typename DataT, typename LeafT, typename OctreeT>
      class OctreeDepthFirstIterator : public OctreeIteratorBase<DataT, LeafT, OctreeT>
      {
        // public typedefs
        typedef typename OctreeIteratorBase<DataT, LeafT, OctreeT>::OctreeBranch OctreeBranch;
        typedef typename OctreeIteratorBase<DataT, LeafT, OctreeT>::OctreeKey OctreeKey;

      public:
        explicit
        OctreeDepthFirstIterator (const OctreeT& octree_arg);

        virtual
        ~OctreeDepthFirstIterator ();

        virtual void
        reset ();

        OctreeDepthFirstIterator&
        operator++ ();

        inline OctreeDepthFirstIterator
        operator++ (int)
        {
          OctreeDepthFirstIterator _Tmp = *this;
          ++*this;
          return (_Tmp);
        }

        void
        skipChildVoxels ();

      protected:
        unsigned char currentChildIdx_;

        std::vector<std::pair<OctreeNode const*, unsigned char> > stack_;
      };


    template<typename DataT, typename LeafT, typename OctreeT>
      class OctreeBreadthFirstIterator : public OctreeIteratorBase<DataT, LeafT, OctreeT>
      {
        // public typedefs
        typedef typename OctreeIteratorBase<DataT, LeafT, OctreeT>::OctreeBranch OctreeBranch;
        typedef typename OctreeIteratorBase<DataT, LeafT, OctreeT>::OctreeKey OctreeKey;

        struct FIFOElement {
          const OctreeNode* node;
          OctreeKey key;
          unsigned int depth;
        };

      public:
        explicit
        OctreeBreadthFirstIterator (const OctreeT& octree_arg);

        virtual
        ~OctreeBreadthFirstIterator ();

        void
        reset ();

        OctreeBreadthFirstIterator&
        operator++ ();

        inline OctreeBreadthFirstIterator
        operator++ (int)
        {
          OctreeBreadthFirstIterator _Tmp = *this;
          ++*this;
          return (_Tmp);
        }

      protected:
        void
        addChildNodesToFIFO (const OctreeNode* node);

        std::deque<FIFOElement> FIFO_;
      };



    template<typename DataT, typename LeafT, typename OctreeT>
      class OctreeLeafNodeIterator : public OctreeDepthFirstIterator<DataT, LeafT, OctreeT>
      {
      public:
        explicit
        OctreeLeafNodeIterator (const OctreeT& octree_arg) :
            OctreeDepthFirstIterator<DataT, LeafT, OctreeT> (octree_arg)
        {
          reset ();
        }

        virtual
        ~OctreeLeafNodeIterator ()
        {
        }

        inline void
        reset ()
        {
          OctreeDepthFirstIterator<DataT, LeafT, OctreeT>::reset ();
        }

        inline OctreeLeafNodeIterator&
        operator++ ()
        {
          do
          {
            OctreeDepthFirstIterator<DataT, LeafT, OctreeT>::operator++ ();
          } while ((this->currentNode_) && (this->currentNode_->getNodeType () != LEAF_NODE));

          return (*this);
        }

        inline OctreeLeafNodeIterator
        operator++ (int)
        {
          OctreeLeafNodeIterator _Tmp = *this;
          ++*this;
          return (_Tmp);
        }

        const LeafT*
        operator* () const
        {
          // return designated object
          const LeafT* ret = NULL;

          if (this->currentNode_ && (this->currentNode_->getNodeType () == LEAF_NODE))
            ret = (const LeafT*)this->currentNode_;
          return (ret);
        }
      };

  }
}

#endif