pointcloud.cpp

// Copyright (c) 2022 Samsung R&D Institute Russia
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#include "nav2_collision_monitor/pointcloud.hpp"
 
#include <functional>
 
#include "sensor_msgs/point_cloud2_iterator.hpp"
#include "tf2/transform_datatypes.hpp"
#include "nav2_ros_common/tf2_factories.hpp"
 
#include "nav2_ros_common/node_utils.hpp"
#include "nav2_util/robot_utils.hpp"
 
namespace nav2_collision_monitor
{
 
PointCloud::PointCloud(
  const nav2::LifecycleNode::WeakPtr & node,
  const std::string & source_name,
  const nav2::TransformBuffer::SharedPtr tf_buffer,
  const std::string & base_frame_id,
  const std::string & global_frame_id,
  const tf2::Duration & transform_tolerance,
  const rclcpp::Duration & source_timeout,
  const bool base_shift_correction)
: Source(
    node, source_name, tf_buffer, base_frame_id, global_frame_id,
    transform_tolerance, source_timeout, base_shift_correction),
  data_(nullptr)
{
  RCLCPP_INFO(logger_, "[%s]: Creating PointCloud", source_name_.c_str());
}
 
PointCloud::~PointCloud()
{
  RCLCPP_INFO(logger_, "[%s]: Destroying PointCloud", source_name_.c_str());
  #if RCLCPP_VERSION_GTE(30, 0, 0)
  data_sub_.shutdown();
  #else
  data_sub_.reset();
  #endif
  auto node = node_.lock();
  if (post_set_params_handler_ && node) {
    node->remove_post_set_parameters_callback(post_set_params_handler_.get());
  }
  post_set_params_handler_.reset();
  if (on_set_params_handler_ && node) {
    node->remove_on_set_parameters_callback(on_set_params_handler_.get());
  }
  on_set_params_handler_.reset();
}
 
bool PointCloud::configure()
{
  if (!Source::configure()) {
    return false;
  }
  auto node = node_.lock();
  if (!node) {
    throw std::runtime_error{"Failed to lock node"};
  }
 
  std::string source_topic;
 
  getParameters(source_topic);
 
  #if RCLCPP_VERSION_GTE(30, 0, 0)
  const point_cloud_transport::TransportHints hint(transport_type_);
  pct_ = std::make_shared<point_cloud_transport::PointCloudTransport>(*node);
  data_sub_ = pct_->subscribe(
    source_topic, nav2::qos::SensorDataQoS(),
    std::bind(&PointCloud::dataCallback, this, std::placeholders::_1),
    {}, &hint
  );
  #else
  data_sub_ = node->create_subscription<sensor_msgs::msg::PointCloud2>(
    source_topic,
    std::bind(&PointCloud::dataCallback, this, std::placeholders::_1),
    nav2::qos::SensorDataQoS());
  #endif
 
  // Add callback for dynamic parameters
  post_set_params_handler_ = node->add_post_set_parameters_callback(
    std::bind(
      &PointCloud::updateParametersCallback,
      this, std::placeholders::_1));
  on_set_params_handler_ = node->add_on_set_parameters_callback(
    std::bind(
      &PointCloud::validateParameterUpdatesCallback,
      this, std::placeholders::_1));
 
  return true;
}
 
bool PointCloud::getSourceData(
  const rclcpp::Time & curr_time,
  std::vector<Point> & data)
{
  std::lock_guard<std::mutex> lock_reinit(mutex_);
  // Ignore data from the source if it is not being published yet or
  // not published for a long time
  if (data_ == nullptr) {
    return false;
  }
  if (!sourceValid(data_->header.stamp, curr_time)) {
    return false;
  }
 
  tf2::Transform tf_transform;
  if (!getTransform(curr_time, data_->header, tf_transform)) {
    return false;
  }
 
  sensor_msgs::PointCloud2ConstIterator<float> iter_x(*data_, "x");
  sensor_msgs::PointCloud2ConstIterator<float> iter_y(*data_, "y");
  sensor_msgs::PointCloud2ConstIterator<float> iter_z(*data_, "z");
 
  bool height_present = false;
  for (const auto & field : data_->fields) {
    if (field.name == "height") {
      height_present = true;
    }
  }
 
// Reference height field
  std::string height_field{"z"};
  if (use_global_height_ && height_present) {
    height_field = "height";
  } else if (use_global_height_) {
    RCLCPP_ERROR(
      logger_, "[%s]: 'use_global_height' parameter true but height field not in cloud",
      source_name_.c_str());
    return false;
  }
  sensor_msgs::PointCloud2ConstIterator<float> iter_height(*data_, height_field);
 
  // Refill data array with PointCloud points in base frame
  for (; iter_x != iter_x.end(); ++iter_x, ++iter_y, ++iter_z) {
    // Transform point coordinates from source frame -> to base frame
    tf2::Vector3 p_v3_s(*iter_x, *iter_y, *iter_z);
 
    double data_height = *iter_z;
    if (use_global_height_) {
      data_height = *iter_height;
      ++iter_height;
    }
 
    // Check range from sensor origin before transformation
    double range = p_v3_s.length();
    if (range < min_range_) {
      continue;
    }
 
    tf2::Vector3 p_v3_b = tf_transform * p_v3_s;
 
    // Still need to transfer height from "z" field if not using global height
    if (!use_global_height_) {
      data_height = p_v3_b.z();
    }
 
    // Refill data array
    if (data_height >= min_height_ && data_height <= max_height_) {
      data.push_back({p_v3_b.x(), p_v3_b.y(), p_v3_b.z(), source_name_});
    }
  }
  return true;
}
 
void PointCloud::getParameters(std::string & source_topic)
{
  auto node = node_.lock();
  if (!node) {
    throw std::runtime_error{"Failed to lock node"};
  }
 
  getCommonParameters(source_topic);
 
  min_height_ = node->declare_or_get_parameter(source_name_ + ".min_height", 0.05);
  max_height_ = node->declare_or_get_parameter(source_name_ + ".max_height", 0.5);
  min_range_ = node->declare_or_get_parameter(source_name_ + ".min_range", 0.0);
  use_global_height_ = node->declare_or_get_parameter(
    source_name_ + ".use_global_height", false);
  transport_type_ = node->declare_or_get_parameter(
    source_name_ + ".transport_type", std::string("raw"));
}
 
void PointCloud::dataCallback(sensor_msgs::msg::PointCloud2::ConstSharedPtr msg)
{
  data_ = msg;
}
 
rcl_interfaces::msg::SetParametersResult PointCloud::validateParameterUpdatesCallback(
  const std::vector<rclcpp::Parameter> & parameters)
{
  rcl_interfaces::msg::SetParametersResult result;
  result.successful = true;
  for (const auto & parameter : parameters) {
    const auto & param_type = parameter.get_type();
    const auto & param_name = parameter.get_name();
    if (param_name.find(source_name_ + ".") != 0) {
      continue;
    }
    if (param_type == ParameterType::PARAMETER_DOUBLE) {
      if (parameter.as_double() < 0.0) {
        RCLCPP_WARN(
        logger_, "The value of parameter '%s' is incorrectly set to %f, "
        "it should be >=0. Ignoring parameter update.",
        param_name.c_str(), parameter.as_double());
        result.successful = false;
      }
    }
  }
  return result;
}
 
void PointCloud::updateParametersCallback(
  const std::vector<rclcpp::Parameter> & parameters)
{
  std::lock_guard<std::mutex> lock_reinit(mutex_);
 
  for (auto parameter : parameters) {
    const auto & param_type = parameter.get_type();
    const auto & param_name = parameter.get_name();
    if (param_name.find(source_name_ + ".") != 0) {
      continue;
    }
    if (param_type == rcl_interfaces::msg::ParameterType::PARAMETER_DOUBLE) {
      if (param_name == source_name_ + "." + "min_height") {
        min_height_ = parameter.as_double();
      } else if (param_name == source_name_ + "." + "max_height") {
        max_height_ = parameter.as_double();
      } else if (param_name == source_name_ + "." + "min_range") {
        min_range_ = parameter.as_double();
      }
    } else if (param_type == rcl_interfaces::msg::ParameterType::PARAMETER_BOOL) {
      if (param_name == source_name_ + "." + "enabled") {
        enabled_ = parameter.as_bool();
      } else if (param_name == source_name_ + "." + "use_global_height") {
        use_global_height_ = parameter.as_bool();
      }
    }
  }
}
 
}  // namespace nav2_collision_monitor