octree_base_pa_ros.h

Go to the documentation of this file.

/******************************************************************************
*                                                                             *
* octree_base_pa_ros.h                                                        *
* ====================                                                        *
*                                                                             *
*******************************************************************************
*                                                                             *
* Repository:                                                                 *
*   https://github.com/TUC-ProAut/ros_octomap                                 *
*                                                                             *
* Chair of Automation Technology, Technische Universität Chemnitz             *
*   https://www.tu-chemnitz.de/etit/proaut                                    *
*                                                                             *
* Author:                                                                     *
*   Peter Weissig                                                             *
*                                                                             *
*******************************************************************************
*                                                                             *
* New BSD License                                                             *
*                                                                             *
* Copyright (c) 2015-2021 TU Chemnitz                                         *
* 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 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 HOLDER 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.                                  *
*                                                                             *
******************************************************************************/

#ifndef __OCTREE_BASE_PA_ROS_H
#define __OCTREE_BASE_PA_ROS_H

// local headers
#include "octomap_pa/addcloud_parameter.h"
#include "octomap_pa/octree_base_pa_ros_parameter.h"

// ros headers
#include <ros/ros.h>

#include <geometry_msgs/Point.h>
#include <sensor_msgs/PointCloud.h>
#include <sensor_msgs/PointCloud2.h>
#include <sensor_msgs/LaserScan.h>
#include <nav_msgs/Path.h>
#include <std_srvs/Empty.h>

#include <octomap_msgs/Octomap.h>

#include <tf/transform_datatypes.h>

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

#include <octomap/octomap.h>

//**************************[cOctreeBasePaRos]*********************************
template <typename OCTREE>
class cOctreeBasePaRos : public OCTREE {
  public:

    typedef OCTREE                   TreeTypeBase;
    typedef cOctreeBasePaRos<OCTREE> TreeTypeFull;

    typedef          pcl::PointCloud<pcl::PointXYZ>      PclPointCloud;
    typedef typename pcl::PointCloud<pcl::PointXYZ>::Ptr PclPointCloudPtr;
    typedef typename pcl::PointCloud<pcl::PointXYZ>::ConstPtr
        PclPointCloudConstPtr;

    typedef ::octomap::OcTreeKey OctKey;

    cOctreeBasePaRos(double resolution);

    virtual ~cOctreeBasePaRos();

    virtual void clear(void);

    bool addCloud(const sensor_msgs::PointCloud2 &cloud,
      const cAddCloudParameter &params,
      const tf::Transform transform = tf::Transform::getIdentity());
    bool addCloud(const sensor_msgs::PointCloud &cloud,
      const cAddCloudParameter &params,
      const tf::Transform transform = tf::Transform::getIdentity());
    bool addCloud(const sensor_msgs::LaserScan &cloud,
      const cAddCloudParameter &params,
      const tf::Transform transform = tf::Transform::getIdentity());

    octomap_msgs::OctomapPtr getOctomap(void) const;
    octomap_msgs::OctomapPtr getOctomapFull(void) const;

    sensor_msgs::PointCloud2Ptr getOctomapPcd(
      const int tree_depth = 0, const bool expand = false) const;
    sensor_msgs::PointCloud2Ptr getOctomapPcdFree(
      const int tree_depth = 0, const bool expand = false) const;

    bool updateTime(const ros::Time &time);
    virtual ros::Time getLastInsertionTime(void) const;
    virtual void setLastInsertionTime(const ros::Time &time);
    ros::Time getOutputTime(void) const;
    void setOutputTime(const ros::Time &time);

    OctKey pointToKey(const geometry_msgs::Point &point) const;
    geometry_msgs::PointPtr keyToPoint(const OctKey &key) const;
    void keyToPoint(const OctKey &key, double &x, double &y, double &z) const;

    bool getChildKey(const OctKey &current, const int current_level,
      OctKey &child, const int child_pos) const;
    bool getParentKey(const OctKey &current, const int current_level,
      OctKey &parent) const;

    bool readFull(const std::string& filename);

    cOctreeBasePaRosParameter rosparams_base_;

  protected:
    ros::Time last_insertion_time_;
    ros::Time current_output_time_;

    bool addCloud(const PclPointCloudPtr &cloud,
      const cAddCloudParameter &params,
      const tf::Transform &transform);

    void getOctomapPcdSub(const OctKey &key, const int current_level,
      const int min_level, PclPointCloud &cloud) const;

    void getChildKeySimple(const OctKey &current, const int current_level,
      OctKey &child, const int child_pos) const;
    void getParentKeySimple(const OctKey &current, const int current_level,
      OctKey &parent) const;
};

#include "octomap_pa/octree_base_pa_ros.hxx"

#endif // __OCTREE_BASE_PA_ROS_H