Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
amcl_node.cpp
1 /*
2  * Copyright (c) 2008, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  */
20 
21 /* Author: Brian Gerkey */
22 
23 #include "nav2_amcl/amcl_node.hpp"
24 
25 #include <algorithm>
26 #include <cstdint>
27 #include <cstdio>
28 #include <ctime>
29 #include <iomanip>
30 #include <memory>
31 #include <string>
32 #include <utility>
33 #include <vector>
34 
35 #include "nav2_amcl/angleutils.hpp"
36 #include "nav2_util/geometry_utils.hpp"
37 #include "nav2_amcl/pf/pf.hpp"
38 #include "nav2_util/string_utils.hpp"
39 #include "nav2_amcl/sensors/laser/laser.hpp"
40 #include "rclcpp/node_options.hpp"
41 #include "tf2/convert.hpp"
42 #include "tf2/utils.hpp"
43 #include "tf2_geometry_msgs/tf2_geometry_msgs.hpp"
44 #include "tf2/LinearMath/Transform.hpp"
45 #include "nav2_ros_common/tf2_factories.hpp"
46 
47 #include "nav2_amcl/portable_utils.hpp"
48 #include "nav2_ros_common/validate_messages.hpp"
49 
50 using rcl_interfaces::msg::ParameterType;
51 using namespace std::chrono_literals;
52 
53 namespace nav2_amcl
54 {
55 using nav2_util::geometry_utils::orientationAroundZAxis;
56 
57 AmclNode::AmclNode(const rclcpp::NodeOptions & options)
58 : nav2::LifecycleNode("amcl", "", options)
59 {
60  RCLCPP_INFO(get_logger(), "Creating");
61  init_pose_[0] = 0.0;
62  init_pose_[1] = 0.0;
63  init_pose_[2] = 0.0;
64  init_cov_[0] = 0.0;
65  init_cov_[1] = 0.0;
66  init_cov_[2] = 0.0;
67 }
68 
69 AmclNode::~AmclNode()
70 {
71 }
72 
73 nav2::CallbackReturn
74 AmclNode::on_configure(const rclcpp_lifecycle::State & /*state*/)
75 {
76  RCLCPP_INFO(get_logger(), "Configuring");
77  callback_group_ = create_callback_group(
78  rclcpp::CallbackGroupType::MutuallyExclusive, false);
79  initParameters();
80  initTransforms();
81  initParticleFilter();
82  initLaserScan();
83  initMessageFilters();
84  initPubSub();
85  initServices();
86  initOdometry();
87  executor_ = std::make_shared<rclcpp::executors::SingleThreadedExecutor>();
88  executor_->add_callback_group(callback_group_, get_node_base_interface());
89  executor_thread_ = std::make_unique<nav2::NodeThread>(executor_);
90  return nav2::CallbackReturn::SUCCESS;
91 }
92 
93 nav2::CallbackReturn
94 AmclNode::on_activate(const rclcpp_lifecycle::State & /*state*/)
95 {
96  RCLCPP_INFO(get_logger(), "Activating");
97 
98  // Lifecycle publishers must be explicitly activated
99  pose_pub_->on_activate();
100  particle_cloud_pub_->on_activate();
101 
102  first_pose_sent_ = false;
103 
104  // Keep track of whether we're in the active state. We won't
105  // process incoming callbacks until we are
106  active_ = true;
107 
108  if (set_initial_pose_) {
109  // ROS parameters take priority over saved pose file
110  if (initialize_at_saved_pose_) {
111  std::ifstream file(saved_pose_filepath_);
112  if (file.is_open()) {
113  RCLCPP_WARN(
114  get_logger(),
115  "Both initial_pose parameters and saved pose file exist. Using ROS parameters.");
116  file.close();
117  }
118  }
119  auto msg = std::make_shared<geometry_msgs::msg::PoseWithCovarianceStamped>();
120 
121  msg->header.stamp = now();
122  msg->header.frame_id = global_frame_id_;
123  msg->pose.pose.position.x = initial_pose_x_;
124  msg->pose.pose.position.y = initial_pose_y_;
125  msg->pose.pose.position.z = initial_pose_z_;
126  msg->pose.pose.orientation = orientationAroundZAxis(initial_pose_yaw_);
127 
128  initialPoseReceived(msg);
129  } else if (initialize_at_saved_pose_) {
130  geometry_msgs::msg::PoseWithCovarianceStamped saved_pose;
131  if (loadPoseFromFile(saved_pose)) {
132  auto msg = std::make_shared<geometry_msgs::msg::PoseWithCovarianceStamped>(saved_pose);
133  initialPoseReceived(msg);
134  } else {
135  RCLCPP_WARN(
136  get_logger(),
137  "initialize_at_saved_pose is true but no saved pose file found at: %s",
138  saved_pose_filepath_.c_str());
139  return nav2::CallbackReturn::FAILURE;
140  }
141  } else if (init_pose_received_on_inactive) {
142  handleInitialPose(last_published_pose_);
143  }
144 
145  // Create pose save timer if save_pose_rate > 0
146  if (save_pose_rate_ > 0.0) {
147  save_pose_timer_ = this->create_timer(
148  std::chrono::duration<double>(1.0 / save_pose_rate_),
149  std::bind(&AmclNode::savePoseTimerCallback, this));
150  }
151 
152  auto node = shared_from_this();
153  // Add callback for dynamic parameters
154  post_set_params_handler_ = node->add_post_set_parameters_callback(
155  std::bind(
156  &AmclNode::updateParametersCallback,
157  this, std::placeholders::_1));
158  on_set_params_handler_ = node->add_on_set_parameters_callback(
159  std::bind(
160  &AmclNode::validateParameterUpdatesCallback,
161  this, std::placeholders::_1));
162 
163  // create bond connection
164  createBond();
165 
166  return nav2::CallbackReturn::SUCCESS;
167 }
168 
169 nav2::CallbackReturn
170 AmclNode::on_deactivate(const rclcpp_lifecycle::State & /*state*/)
171 {
172  RCLCPP_INFO(get_logger(), "Deactivating");
173 
174  active_ = false;
175 
176  // Lifecycle publishers must be explicitly deactivated
177  pose_pub_->on_deactivate();
178  particle_cloud_pub_->on_deactivate();
179 
180  // Stop pose save timer
181  if (save_pose_timer_) {
182  save_pose_timer_->cancel();
183  save_pose_timer_.reset();
184  }
185 
186  // shutdown and reset dynamic parameter handler
187  remove_post_set_parameters_callback(post_set_params_handler_.get());
188  post_set_params_handler_.reset();
189  remove_on_set_parameters_callback(on_set_params_handler_.get());
190  on_set_params_handler_.reset();
191 
192  // destroy bond connection
193  destroyBond();
194 
195  return nav2::CallbackReturn::SUCCESS;
196 }
197 
198 nav2::CallbackReturn
199 AmclNode::on_cleanup(const rclcpp_lifecycle::State & /*state*/)
200 {
201  RCLCPP_INFO(get_logger(), "Cleaning up");
202 
203  executor_thread_.reset();
204 
205  // Get rid of the inputs first (services and message filter input), so we
206  // don't continue to process incoming messages
207  global_loc_srv_.reset();
208  initial_guess_srv_.reset();
209  nomotion_update_srv_.reset();
210  initial_pose_sub_.reset();
211  laser_scan_connection_.disconnect();
212  tf_listener_.reset(); // listener may access lase_scan_filter_, so it should be reset earlier
213  laser_scan_filter_.reset();
214  laser_scan_sub_.reset();
215 
216  // Map
217  map_sub_.reset(); // map_sub_ may access map_, so it should be reset earlier
218  if (map_ != NULL) {
219  map_free(map_);
220  map_ = nullptr;
221  }
222  first_map_received_ = false;
223  free_space_indices.resize(0);
224 
225  // Transforms
226  tf_broadcaster_.reset();
227  tf_buffer_.reset();
228 
229  // PubSub
230  pose_pub_.reset();
231  particle_cloud_pub_.reset();
232 
233  // Odometry
234  motion_model_.reset();
235 
236  // Particle Filter
237  pf_free(pf_);
238  pf_ = nullptr;
239 
240  // Laser Scan
241  lasers_.clear();
242  lasers_update_.clear();
243  frame_to_laser_.clear();
244  force_update_ = true;
245 
246  if (set_initial_pose_) {
247  set_parameter(
248  rclcpp::Parameter(
249  "initial_pose.x",
250  rclcpp::ParameterValue(last_published_pose_.pose.pose.position.x)));
251  set_parameter(
252  rclcpp::Parameter(
253  "initial_pose.y",
254  rclcpp::ParameterValue(last_published_pose_.pose.pose.position.y)));
255  set_parameter(
256  rclcpp::Parameter(
257  "initial_pose.z",
258  rclcpp::ParameterValue(last_published_pose_.pose.pose.position.z)));
259  set_parameter(
260  rclcpp::Parameter(
261  "initial_pose.yaw",
262  rclcpp::ParameterValue(tf2::getYaw(last_published_pose_.pose.pose.orientation))));
263  }
264 
265  return nav2::CallbackReturn::SUCCESS;
266 }
267 
268 nav2::CallbackReturn
269 AmclNode::on_shutdown(const rclcpp_lifecycle::State & /*state*/)
270 {
271  RCLCPP_INFO(get_logger(), "Shutting down");
272  return nav2::CallbackReturn::SUCCESS;
273 }
274 
275 bool
276 AmclNode::checkElapsedTime(std::chrono::seconds check_interval, rclcpp::Time last_time)
277 {
278  rclcpp::Duration elapsed_time = now() - last_time;
279  if (elapsed_time.nanoseconds() * 1e-9 > check_interval.count()) {
280  return true;
281  }
282  return false;
283 }
284 
285 #if NEW_UNIFORM_SAMPLING
286 std::vector<AmclNode::Point2D> AmclNode::free_space_indices;
287 #endif
288 
289 bool
290 AmclNode::getOdomPose(
291  geometry_msgs::msg::PoseStamped & odom_pose,
292  double & x, double & y, double & yaw,
293  const rclcpp::Time & sensor_timestamp, const std::string & frame_id)
294 {
295  // Get the robot's pose
296  geometry_msgs::msg::PoseStamped ident;
297  ident.header.frame_id = frame_id;
298  ident.header.stamp = sensor_timestamp;
299  tf2::toMsg(tf2::Transform::getIdentity(), ident.pose);
300 
301  try {
302  tf_buffer_->transform(ident, odom_pose, odom_frame_id_);
303  } catch (tf2::TransformException & e) {
304  ++scan_error_count_;
305  if (scan_error_count_ % 20 == 0) {
306  RCLCPP_ERROR(
307  get_logger(), "(%d) consecutive laser scan transforms failed: (%s)", scan_error_count_,
308  e.what());
309  }
310  return false;
311  }
312 
313  scan_error_count_ = 0; // reset since we got a good transform
314  x = odom_pose.pose.position.x;
315  y = odom_pose.pose.position.y;
316  yaw = tf2::getYaw(odom_pose.pose.orientation);
317 
318  return true;
319 }
320 
322 AmclNode::uniformPoseGenerator(void * arg)
323 {
324  map_t * map = reinterpret_cast<map_t *>(arg);
325 
326 #if NEW_UNIFORM_SAMPLING
327  unsigned int rand_index = drand48() * free_space_indices.size();
328  AmclNode::Point2D free_point = free_space_indices[rand_index];
329  pf_vector_t p;
330  p.v[0] = MAP_WXGX(map, free_point.x);
331  p.v[1] = MAP_WYGY(map, free_point.y);
332  p.v[2] = drand48() * 2 * M_PI - M_PI;
333 #else
334  double min_x, max_x, min_y, max_y;
335 
336  min_x = (map->size_x * map->scale) / 2.0 - map->origin_x;
337  max_x = (map->size_x * map->scale) / 2.0 + map->origin_x;
338  min_y = (map->size_y * map->scale) / 2.0 - map->origin_y;
339  max_y = (map->size_y * map->scale) / 2.0 + map->origin_y;
340 
341  pf_vector_t p;
342 
343  RCLCPP_DEBUG(get_logger(), "Generating new uniform sample");
344  for (;; ) {
345  p.v[0] = min_x + drand48() * (max_x - min_x);
346  p.v[1] = min_y + drand48() * (max_y - min_y);
347  p.v[2] = drand48() * 2 * M_PI - M_PI;
348  // Check that it's a free cell
349  int i, j;
350  i = MAP_GXWX(map, p.v[0]);
351  j = MAP_GYWY(map, p.v[1]);
352  if (MAP_VALID(map, i, j) && (map->cells[MAP_INDEX(map, i, j)].occ_state == -1)) {
353  break;
354  }
355  }
356 #endif
357  return p;
358 }
359 
360 void
361 AmclNode::globalLocalizationCallback(
362  const std::shared_ptr<rmw_request_id_t>/*request_header*/,
363  const std::shared_ptr<std_srvs::srv::Empty::Request>/*req*/,
364  std::shared_ptr<std_srvs::srv::Empty::Response>/*res*/)
365 {
366  std::lock_guard<std::recursive_mutex> cfl(mutex_);
367 
368  if (!map_) {
369  RCLCPP_ERROR(get_logger(), "Cannot initialize globally before a map is received");
370  return;
371  }
372 
373  RCLCPP_INFO(get_logger(), "Initializing with uniform distribution");
374 
375  pf_init_model(
376  pf_, (pf_init_model_fn_t)AmclNode::uniformPoseGenerator,
377  reinterpret_cast<void *>(map_));
378  RCLCPP_INFO(get_logger(), "Global initialisation done!");
379  initial_pose_is_known_ = true;
380  pf_init_ = false;
381 }
382 
383 void
384 AmclNode::initialPoseReceivedSrv(
385  const std::shared_ptr<rmw_request_id_t>/*request_header*/,
386  const std::shared_ptr<nav2_msgs::srv::SetInitialPose::Request> req,
387  std::shared_ptr<nav2_msgs::srv::SetInitialPose::Response>/*res*/)
388 {
389  initialPoseReceived(std::make_shared<geometry_msgs::msg::PoseWithCovarianceStamped>(req->pose));
390 }
391 
392 // force nomotion updates (amcl updating without requiring motion)
393 void
394 AmclNode::nomotionUpdateCallback(
395  const std::shared_ptr<rmw_request_id_t>/*request_header*/,
396  const std::shared_ptr<std_srvs::srv::Empty::Request>/*req*/,
397  std::shared_ptr<std_srvs::srv::Empty::Response>/*res*/)
398 {
399  RCLCPP_INFO(get_logger(), "Requesting no-motion update");
400  force_update_ = true;
401 }
402 
403 void
404 AmclNode::initialPoseReceived(
405  const geometry_msgs::msg::PoseWithCovarianceStamped::ConstSharedPtr & msg)
406 {
407  std::lock_guard<std::recursive_mutex> cfl(mutex_);
408 
409  RCLCPP_INFO(get_logger(), "initialPoseReceived");
410 
411  if (!nav2::validateMsg(*msg)) {
412  RCLCPP_ERROR(get_logger(), "Received initialpose message is malformed. Rejecting.");
413  return;
414  }
415  if (msg->header.frame_id != global_frame_id_) {
416  RCLCPP_WARN(
417  get_logger(),
418  "Ignoring initial pose in frame \"%s\"; initial poses must be in the global frame, \"%s\"",
419  msg->header.frame_id.c_str(),
420  global_frame_id_.c_str());
421  return;
422  }
423  if (first_map_received_ && (abs(msg->pose.pose.position.x) > map_->size_x ||
424  abs(msg->pose.pose.position.y) > map_->size_y))
425  {
426  RCLCPP_ERROR(
427  get_logger(), "Received initialpose from message is out of the size of map. Rejecting.");
428  return;
429  }
430 
431  // Overriding last published pose to initial pose
432  last_published_pose_ = *msg;
433 
434  if (!active_) {
435  init_pose_received_on_inactive = true;
436  RCLCPP_WARN(
437  get_logger(), "Received initial pose request, "
438  "but AMCL is not yet in the active state");
439  return;
440  }
441  handleInitialPose(last_published_pose_);
442 }
443 
444 void
445 AmclNode::handleInitialPose(geometry_msgs::msg::PoseWithCovarianceStamped & msg)
446 {
447  std::lock_guard<std::recursive_mutex> cfl(mutex_);
448  // In case the client sent us a pose estimate in the past, integrate the
449  // intervening odometric change.
450  geometry_msgs::msg::TransformStamped tx_odom;
451  try {
452  rclcpp::Time rclcpp_time = now();
453  tf2::TimePoint tf2_time(std::chrono::nanoseconds(rclcpp_time.nanoseconds()));
454 
455  // Check if the transform is available
456  tx_odom = tf_buffer_->lookupTransform(
457  base_frame_id_, tf2_ros::fromMsg(msg.header.stamp),
458  base_frame_id_, tf2_time, odom_frame_id_);
459  } catch (tf2::TransformException & e) {
460  // If we've never sent a transform, then this is normal, because the
461  // global_frame_id_ frame doesn't exist. We only care about in-time
462  // transformation for on-the-move pose-setting, so ignoring this
463  // startup condition doesn't really cost us anything.
464  if (sent_first_transform_) {
465  RCLCPP_WARN(get_logger(), "Failed to transform initial pose in time (%s)", e.what());
466  }
467  tf2::impl::Converter<false, true>::convert(tf2::Transform::getIdentity(), tx_odom.transform);
468  }
469 
470  tf2::Transform tx_odom_tf2;
471  tf2::impl::Converter<true, false>::convert(tx_odom.transform, tx_odom_tf2);
472 
473  tf2::Transform pose_old;
474  tf2::impl::Converter<true, false>::convert(msg.pose.pose, pose_old);
475 
476  tf2::Transform pose_new = pose_old * tx_odom_tf2;
477 
478  // Transform into the global frame
479 
480  RCLCPP_INFO(
481  get_logger(), "Setting pose (%.6f): %.3f %.3f %.3f",
482  now().nanoseconds() * 1e-9,
483  pose_new.getOrigin().x(),
484  pose_new.getOrigin().y(),
485  tf2::getYaw(pose_new.getRotation()));
486 
487  // Re-initialize the filter
488  pf_vector_t pf_init_pose_mean = pf_vector_zero();
489  pf_init_pose_mean.v[0] = pose_new.getOrigin().x();
490  pf_init_pose_mean.v[1] = pose_new.getOrigin().y();
491  pf_init_pose_mean.v[2] = tf2::getYaw(pose_new.getRotation());
492 
493  pf_matrix_t pf_init_pose_cov = pf_matrix_zero();
494  // Copy in the covariance, converting from 6-D to 3-D
495  for (int i = 0; i < 2; i++) {
496  for (int j = 0; j < 2; j++) {
497  pf_init_pose_cov.m[i][j] = msg.pose.covariance[6 * i + j];
498  }
499  }
500 
501  pf_init_pose_cov.m[2][2] = msg.pose.covariance[6 * 5 + 5];
502 
503  pf_init(pf_, pf_init_pose_mean, pf_init_pose_cov);
504  pf_init_ = false;
505  init_pose_received_on_inactive = false;
506  initial_pose_is_known_ = true;
507 }
508 
509 void
510 AmclNode::laserReceived(sensor_msgs::msg::LaserScan::ConstSharedPtr laser_scan)
511 {
512  std::lock_guard<std::recursive_mutex> cfl(mutex_);
513 
514  // Since the sensor data is continually being published by the simulator or robot,
515  // we don't want our callbacks to fire until we're in the active state
516  if (!active_) {return;}
517  if (!first_map_received_) {
518  if (checkElapsedTime(2s, last_time_printed_msg_)) {
519  RCLCPP_WARN(get_logger(), "Waiting for map....");
520  last_time_printed_msg_ = now();
521  }
522  return;
523  }
524 
525  std::string laser_scan_frame_id = laser_scan->header.frame_id;
526  last_laser_received_ts_ = now();
527  int laser_index = -1;
528  geometry_msgs::msg::PoseStamped laser_pose;
529 
530  // Do we have the base->base_laser Tx yet?
531  if (frame_to_laser_.find(laser_scan_frame_id) == frame_to_laser_.end()) {
532  if (!addNewScanner(laser_index, laser_scan, laser_scan_frame_id, laser_pose)) {
533  return; // could not find transform
534  }
535  } else {
536  // we have the laser pose, retrieve laser index
537  laser_index = frame_to_laser_[laser_scan->header.frame_id];
538  }
539 
540  // Where was the robot when this scan was taken?
541  pf_vector_t pose;
542  if (!getOdomPose(
543  latest_odom_pose_, pose.v[0], pose.v[1], pose.v[2],
544  laser_scan->header.stamp, base_frame_id_))
545  {
546  RCLCPP_ERROR(get_logger(), "Couldn't determine robot's pose associated with laser scan");
547  return;
548  }
549 
550  pf_vector_t delta = pf_vector_zero();
551  bool force_publication = false;
552  if (!pf_init_) {
553  // Pose at last filter update
554  pf_odom_pose_ = pose;
555  pf_init_ = true;
556 
557  for (unsigned int i = 0; i < lasers_update_.size(); i++) {
558  lasers_update_[i] = true;
559  }
560 
561  force_publication = true;
562  resample_count_ = 0;
563  } else {
564  // Set the laser update flags
565  if (shouldUpdateFilter(pose, delta)) {
566  for (unsigned int i = 0; i < lasers_update_.size(); i++) {
567  lasers_update_[i] = true;
568  }
569  }
570  if (lasers_update_[laser_index]) {
571  motion_model_->odometryUpdate(pf_, pose, delta);
572  }
573  force_update_ = false;
574  }
575 
576  bool resampled = false;
577 
578  // If the robot has moved, update the filter
579  if (lasers_update_[laser_index]) {
580  updateFilter(laser_index, laser_scan, pose);
581 
582  // Resample the particles
583  if (!(++resample_count_ % resample_interval_)) {
584  pf_update_resample(pf_, reinterpret_cast<void *>(map_));
585  resampled = true;
586  }
587 
588  pf_sample_set_t * set = pf_->sets + pf_->current_set;
589  RCLCPP_DEBUG(get_logger(), "Num samples: %d\n", set->sample_count);
590 
591  if (!force_update_) {
592  publishParticleCloud(set);
593  }
594  }
595  if (resampled || force_publication || !first_pose_sent_) {
596  amcl_hyp_t max_weight_hyps;
597  std::vector<amcl_hyp_t> hyps;
598  int max_weight_hyp = -1;
599  if (getMaxWeightHyp(hyps, max_weight_hyps, max_weight_hyp)) {
600  publishAmclPose(laser_scan, hyps, max_weight_hyp);
601  calculateMaptoOdomTransform(laser_scan, hyps, max_weight_hyp);
602 
603  if (tf_broadcast_ == true) {
604  // We want to send a transform that is good up until a
605  // tolerance time so that odom can be used
606  auto stamp = tf2_ros::fromMsg(laser_scan->header.stamp);
607  tf2::TimePoint transform_expiration = stamp + transform_tolerance_;
608  sendMapToOdomTransform(transform_expiration);
609  sent_first_transform_ = true;
610  }
611  } else {
612  RCLCPP_ERROR(get_logger(), "No pose!");
613  }
614  } else if (latest_tf_valid_) {
615  if (tf_broadcast_ == true) {
616  // Nothing changed, so we'll just republish the last transform, to keep
617  // everybody happy.
618  tf2::TimePoint transform_expiration = tf2_ros::fromMsg(laser_scan->header.stamp) +
619  transform_tolerance_;
620  sendMapToOdomTransform(transform_expiration);
621  }
622  }
623 }
624 
625 bool AmclNode::addNewScanner(
626  int & laser_index,
627  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
628  const std::string & laser_scan_frame_id,
629  geometry_msgs::msg::PoseStamped & laser_pose)
630 {
631  lasers_.push_back(createLaserObject());
632  lasers_update_.push_back(true);
633  laser_index = frame_to_laser_.size();
634 
635  geometry_msgs::msg::PoseStamped ident;
636  ident.header.frame_id = laser_scan_frame_id;
637  ident.header.stamp = rclcpp::Time();
638  tf2::toMsg(tf2::Transform::getIdentity(), ident.pose);
639  try {
640  tf_buffer_->transform(ident, laser_pose, base_frame_id_, transform_tolerance_);
641  } catch (tf2::TransformException & e) {
642  RCLCPP_ERROR(
643  get_logger(), "Couldn't transform from %s to %s, "
644  "even though the message notifier is in use: (%s)",
645  laser_scan->header.frame_id.c_str(),
646  base_frame_id_.c_str(), e.what());
647  return false;
648  }
649 
650  pf_vector_t laser_pose_v;
651  laser_pose_v.v[0] = laser_pose.pose.position.x;
652  laser_pose_v.v[1] = laser_pose.pose.position.y;
653  // laser mounting angle gets computed later -> set to 0 here!
654  laser_pose_v.v[2] = 0;
655  lasers_[laser_index]->SetLaserPose(laser_pose_v);
656  frame_to_laser_[laser_scan->header.frame_id] = laser_index;
657  return true;
658 }
659 
660 bool AmclNode::shouldUpdateFilter(const pf_vector_t pose, pf_vector_t & delta)
661 {
662  delta.v[0] = pose.v[0] - pf_odom_pose_.v[0];
663  delta.v[1] = pose.v[1] - pf_odom_pose_.v[1];
664  delta.v[2] = angleutils::angle_diff(pose.v[2], pf_odom_pose_.v[2]);
665 
666  // See if we should update the filter
667  bool update = fabs(delta.v[0]) > d_thresh_ ||
668  fabs(delta.v[1]) > d_thresh_ ||
669  fabs(delta.v[2]) > a_thresh_;
670  update = update || force_update_;
671  return update;
672 }
673 
674 bool AmclNode::updateFilter(
675  const int & laser_index,
676  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
677  const pf_vector_t & pose)
678 {
679  nav2_amcl::LaserData ldata;
680  ldata.laser = lasers_[laser_index].get();
681  ldata.range_count = laser_scan->ranges.size();
682  // To account for lasers that are mounted upside-down, we determine the
683  // min, max, and increment angles of the laser in the base frame.
684  //
685  // Construct min and max angles of laser, in the base_link frame.
686  // Here we set the roll pitch yaw of the lasers. We assume roll and pitch are zero.
687  geometry_msgs::msg::QuaternionStamped min_q, inc_q;
688  min_q.header.stamp = laser_scan->header.stamp;
689  min_q.header.frame_id = laser_scan->header.frame_id;
690  min_q.quaternion = orientationAroundZAxis(laser_scan->angle_min);
691 
692  inc_q.header = min_q.header;
693  inc_q.quaternion = orientationAroundZAxis(laser_scan->angle_min + laser_scan->angle_increment);
694  try {
695  tf_buffer_->transform(min_q, min_q, base_frame_id_);
696  tf_buffer_->transform(inc_q, inc_q, base_frame_id_);
697  } catch (tf2::TransformException & e) {
698  RCLCPP_WARN(
699  get_logger(), "Unable to transform min/max laser angles into base frame: %s",
700  e.what());
701  return false;
702  }
703  double angle_min = tf2::getYaw(min_q.quaternion);
704  double angle_increment = tf2::getYaw(inc_q.quaternion) - angle_min;
705 
706  // wrapping angle to [-pi .. pi]
707  angle_increment = fmod(angle_increment + 5 * M_PI, 2 * M_PI) - M_PI;
708 
709  RCLCPP_DEBUG(
710  get_logger(), "Laser %d angles in base frame: min: %.3f inc: %.3f", laser_index, angle_min,
711  angle_increment);
712 
713  // Check the validity of range_max, must > 0.0
714  if (laser_scan->range_max <= 0.0) {
715  RCLCPP_WARN(
716  get_logger(), "wrong range_max of laser_scan data: %f. The message could be malformed."
717  " Ignore this message and stop updating.",
718  laser_scan->range_max);
719  return false;
720  }
721 
722  // Apply range min/max thresholds, if the user supplied them
723  if (laser_max_range_ > 0.0) {
724  ldata.range_max = std::min(laser_scan->range_max, static_cast<float>(laser_max_range_));
725  } else {
726  ldata.range_max = laser_scan->range_max;
727  }
728  double range_min;
729  if (laser_min_range_ > 0.0) {
730  range_min = std::max(laser_scan->range_min, static_cast<float>(laser_min_range_));
731  } else {
732  range_min = laser_scan->range_min;
733  }
734 
735  // The LaserData destructor will free this memory
736  ldata.ranges = new double[ldata.range_count][2];
737  for (int i = 0; i < ldata.range_count; i++) {
738  // amcl doesn't (yet) have a concept of min range. So we'll map short
739  // readings to max range.
740  if (laser_scan->ranges[i] <= range_min) {
741  ldata.ranges[i][0] = ldata.range_max;
742  } else {
743  ldata.ranges[i][0] = laser_scan->ranges[i];
744  }
745  // Compute bearing
746  ldata.ranges[i][1] = angle_min +
747  (i * angle_increment);
748  }
749  lasers_[laser_index]->sensorUpdate(pf_, reinterpret_cast<nav2_amcl::LaserData *>(&ldata));
750  lasers_update_[laser_index] = false;
751  pf_odom_pose_ = pose;
752  return true;
753 }
754 
755 void
756 AmclNode::publishParticleCloud(const pf_sample_set_t * set)
757 {
758  // If initial pose is not known, AMCL does not know the current pose
759  if (!initial_pose_is_known_) {return;}
760  auto cloud_with_weights_msg = std::make_unique<nav2_msgs::msg::ParticleCloud>();
761  cloud_with_weights_msg->header.stamp = this->now();
762  cloud_with_weights_msg->header.frame_id = global_frame_id_;
763  cloud_with_weights_msg->particles.resize(set->sample_count);
764 
765  for (int i = 0; i < set->sample_count; i++) {
766  cloud_with_weights_msg->particles[i].pose.position.x = set->samples[i].pose.v[0];
767  cloud_with_weights_msg->particles[i].pose.position.y = set->samples[i].pose.v[1];
768  cloud_with_weights_msg->particles[i].pose.position.z = 0;
769  cloud_with_weights_msg->particles[i].pose.orientation = orientationAroundZAxis(
770  set->samples[i].pose.v[2]);
771  cloud_with_weights_msg->particles[i].weight = set->samples[i].weight;
772  }
773 
774  particle_cloud_pub_->publish(std::move(cloud_with_weights_msg));
775 }
776 
777 bool
778 AmclNode::getMaxWeightHyp(
779  std::vector<amcl_hyp_t> & hyps, amcl_hyp_t & max_weight_hyps,
780  int & max_weight_hyp)
781 {
782  // Read out the current hypotheses
783  double max_weight = 0.0;
784  hyps.resize(pf_->sets[pf_->current_set].cluster_count);
785  for (int hyp_count = 0;
786  hyp_count < pf_->sets[pf_->current_set].cluster_count; hyp_count++)
787  {
788  double weight;
789  pf_vector_t pose_mean;
790  pf_matrix_t pose_cov;
791  if (!pf_get_cluster_stats(pf_, hyp_count, &weight, &pose_mean, &pose_cov)) {
792  RCLCPP_ERROR(get_logger(), "Couldn't get stats on cluster %d", hyp_count);
793  return false;
794  }
795 
796  hyps[hyp_count].weight = weight;
797  hyps[hyp_count].pf_pose_mean = pose_mean;
798  hyps[hyp_count].pf_pose_cov = pose_cov;
799 
800  if (hyps[hyp_count].weight > max_weight) {
801  max_weight = hyps[hyp_count].weight;
802  max_weight_hyp = hyp_count;
803  }
804  }
805 
806  if (max_weight > 0.0) {
807  RCLCPP_DEBUG(
808  get_logger(), "Max weight pose: %.3f %.3f %.3f",
809  hyps[max_weight_hyp].pf_pose_mean.v[0],
810  hyps[max_weight_hyp].pf_pose_mean.v[1],
811  hyps[max_weight_hyp].pf_pose_mean.v[2]);
812 
813  max_weight_hyps = hyps[max_weight_hyp];
814  return true;
815  }
816  return false;
817 }
818 
819 void
820 AmclNode::publishAmclPose(
821  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
822  const std::vector<amcl_hyp_t> & hyps, const int & max_weight_hyp)
823 {
824  // If initial pose is not known, AMCL does not know the current pose
825  if (!initial_pose_is_known_) {
826  if (checkElapsedTime(2s, last_time_printed_msg_)) {
827  RCLCPP_WARN(
828  get_logger(), "AMCL cannot publish a pose or update the transform. "
829  "Please set the initial pose...");
830  last_time_printed_msg_ = now();
831  }
832  return;
833  }
834 
835  auto p = std::make_unique<geometry_msgs::msg::PoseWithCovarianceStamped>();
836  // Fill in the header
837  p->header.frame_id = global_frame_id_;
838  p->header.stamp = laser_scan->header.stamp;
839  // Copy in the pose
840  p->pose.pose.position.x = hyps[max_weight_hyp].pf_pose_mean.v[0];
841  p->pose.pose.position.y = hyps[max_weight_hyp].pf_pose_mean.v[1];
842  p->pose.pose.orientation = orientationAroundZAxis(hyps[max_weight_hyp].pf_pose_mean.v[2]);
843  // Copy in the covariance, converting from 3-D to 6-D
844  pf_sample_set_t * set = pf_->sets + pf_->current_set;
845  for (int i = 0; i < 2; i++) {
846  for (int j = 0; j < 2; j++) {
847  // Report the overall filter covariance, rather than the
848  // covariance for the highest-weight cluster
849  // p->covariance[6*i+j] = hyps[max_weight_hyp].pf_pose_cov.m[i][j];
850  p->pose.covariance[6 * i + j] = set->cov.m[i][j];
851  }
852  }
853  p->pose.covariance[6 * 5 + 5] = set->cov.m[2][2];
854  float temp = 0.0;
855  for (auto covariance_value : p->pose.covariance) {
856  temp += covariance_value;
857  }
858  temp += p->pose.pose.position.x + p->pose.pose.position.y;
859  if (!std::isnan(temp)) {
860  RCLCPP_DEBUG(get_logger(), "Publishing pose");
861  last_published_pose_ = *p;
862  first_pose_sent_ = true;
863  pose_pub_->publish(std::move(p));
864  } else {
865  RCLCPP_WARN(
866  get_logger(), "AMCL covariance or pose is NaN, likely due to an invalid "
867  "configuration or faulty sensor measurements! Pose is not available!");
868  }
869 
870  RCLCPP_DEBUG(
871  get_logger(), "New pose: %6.3f %6.3f %6.3f",
872  hyps[max_weight_hyp].pf_pose_mean.v[0],
873  hyps[max_weight_hyp].pf_pose_mean.v[1],
874  hyps[max_weight_hyp].pf_pose_mean.v[2]);
875 }
876 
877 void
878 AmclNode::calculateMaptoOdomTransform(
879  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
880  const std::vector<amcl_hyp_t> & hyps, const int & max_weight_hyp)
881 {
882  // subtracting base to odom from map to base and send map to odom instead
883  geometry_msgs::msg::PoseStamped odom_to_map;
884  try {
885  tf2::Quaternion q;
886  q.setRPY(0, 0, hyps[max_weight_hyp].pf_pose_mean.v[2]);
887  tf2::Transform tmp_tf(q, tf2::Vector3(
888  hyps[max_weight_hyp].pf_pose_mean.v[0],
889  hyps[max_weight_hyp].pf_pose_mean.v[1],
890  0.0));
891 
892  geometry_msgs::msg::PoseStamped tmp_tf_stamped;
893  tmp_tf_stamped.header.frame_id = base_frame_id_;
894  tmp_tf_stamped.header.stamp = laser_scan->header.stamp;
895  tf2::toMsg(tmp_tf.inverse(), tmp_tf_stamped.pose);
896 
897  tf_buffer_->transform(tmp_tf_stamped, odom_to_map, odom_frame_id_);
898  } catch (tf2::TransformException & e) {
899  RCLCPP_DEBUG(get_logger(), "Failed to subtract base to odom transform: (%s)", e.what());
900  return;
901  }
902 
903  tf2::impl::Converter<true, false>::convert(odom_to_map.pose, latest_tf_);
904  latest_tf_valid_ = true;
905 }
906 
907 void
908 AmclNode::sendMapToOdomTransform(const tf2::TimePoint & transform_expiration)
909 {
910  // AMCL will update transform only when it has knowledge about robot's initial position
911  if (!initial_pose_is_known_) {return;}
912  geometry_msgs::msg::TransformStamped tmp_tf_stamped;
913  tmp_tf_stamped.header.frame_id = global_frame_id_;
914  tmp_tf_stamped.header.stamp = tf2_ros::toMsg(transform_expiration);
915  tmp_tf_stamped.child_frame_id = odom_frame_id_;
916  tf2::impl::Converter<false, true>::convert(latest_tf_.inverse(), tmp_tf_stamped.transform);
917  tf_broadcaster_->sendTransform(tmp_tf_stamped);
918 }
919 
920 std::unique_ptr<nav2_amcl::Laser>
921 AmclNode::createLaserObject()
922 {
923  RCLCPP_INFO(get_logger(), "createLaserObject");
924 
925  if (sensor_model_type_ == "beam") {
926  return std::make_unique<nav2_amcl::BeamModel>(
927  z_hit_, z_short_, z_max_, z_rand_, sigma_hit_, lambda_short_,
928  0.0, max_beams_, map_);
929  }
930 
931  if (sensor_model_type_ == "likelihood_field_prob") {
932  return std::make_unique<nav2_amcl::LikelihoodFieldModelProb>(
933  z_hit_, z_rand_, sigma_hit_,
934  laser_likelihood_max_dist_, do_beamskip_, beam_skip_distance_, beam_skip_threshold_,
935  beam_skip_error_threshold_, max_beams_, map_);
936  }
937 
938  return std::make_unique<nav2_amcl::LikelihoodFieldModel>(
939  z_hit_, z_rand_, sigma_hit_,
940  laser_likelihood_max_dist_, max_beams_, map_);
941 }
942 
943 void
944 AmclNode::initParameters()
945 {
946  double tmp_tol;
947 
948  alpha1_ = this->declare_or_get_parameter("alpha1", 0.2);
949  alpha2_ = this->declare_or_get_parameter("alpha2", 0.2);
950  alpha3_ = this->declare_or_get_parameter("alpha3", 0.2);
951  alpha4_ = this->declare_or_get_parameter("alpha4", 0.2);
952  alpha5_ = this->declare_or_get_parameter("alpha5", 0.2);
953  base_frame_id_ = this->declare_or_get_parameter("base_frame_id", std::string{"base_footprint"});
954  beam_skip_distance_ = this->declare_or_get_parameter("beam_skip_distance", 0.5);
955  beam_skip_error_threshold_ = this->declare_or_get_parameter("beam_skip_error_threshold", 0.9);
956  beam_skip_threshold_ = this->declare_or_get_parameter("beam_skip_threshold", 0.3);
957  do_beamskip_ = this->declare_or_get_parameter("do_beamskip", false);
958  global_frame_id_ = this->declare_or_get_parameter("global_frame_id", std::string{"map"});
959  lambda_short_ = this->declare_or_get_parameter("lambda_short", 0.1);
960  laser_likelihood_max_dist_ = this->declare_or_get_parameter("laser_likelihood_max_dist", 2.0);
961  laser_max_range_ = this->declare_or_get_parameter("laser_max_range", 100.0);
962  laser_min_range_ = this->declare_or_get_parameter("laser_min_range", -1.0);
963  sensor_model_type_ = this->declare_or_get_parameter(
964  "laser_model_type", std::string{"likelihood_field"});
965  set_initial_pose_ = this->declare_or_get_parameter("set_initial_pose", false);
966  initial_pose_x_ = this->declare_or_get_parameter("initial_pose.x", 0.0);
967  initial_pose_y_ = this->declare_or_get_parameter("initial_pose.y", 0.0);
968  initial_pose_z_ = this->declare_or_get_parameter("initial_pose.z", 0.0);
969  initial_pose_yaw_ = this->declare_or_get_parameter("initial_pose.yaw", 0.0);
970  max_beams_ = this->declare_or_get_parameter("max_beams", 60);
971  max_particles_ = this->declare_or_get_parameter("max_particles", 2000);
972  min_particles_ = this->declare_or_get_parameter("min_particles", 500);
973  odom_frame_id_ = this->declare_or_get_parameter("odom_frame_id", std::string{"odom"});
974  pf_err_ = this->declare_or_get_parameter("pf_err", 0.05);
975  pf_z_ = this->declare_or_get_parameter("pf_z", 0.99);
976  alpha_fast_ = this->declare_or_get_parameter("recovery_alpha_fast", 0.0);
977  alpha_slow_ = this->declare_or_get_parameter("recovery_alpha_slow", 0.0);
978  resample_interval_ = this->declare_or_get_parameter("resample_interval", 1);
979  robot_model_type_ = this->declare_or_get_parameter(
980  "robot_model_type", std::string{"nav2_amcl::DifferentialMotionModel"});
981  save_pose_rate_ = this->declare_or_get_parameter("save_pose_rate", 0.5);
982  initialize_at_saved_pose_ = this->declare_or_get_parameter("initialize_at_saved_pose", false);
983  saved_pose_filepath_ = this->declare_or_get_parameter(
984  "saved_pose_filepath", std::string("/tmp/amcl_saved_pose"));
985  sigma_hit_ = this->declare_or_get_parameter("sigma_hit", 0.2);
986  tf_broadcast_ = this->declare_or_get_parameter("tf_broadcast", true);
987  tmp_tol = this->declare_or_get_parameter("transform_tolerance", 1.0);
988  a_thresh_ = this->declare_or_get_parameter("update_min_a", 0.2);
989  d_thresh_ = this->declare_or_get_parameter("update_min_d", 0.25);
990  z_hit_ = this->declare_or_get_parameter("z_hit", 0.5);
991  z_max_ = this->declare_or_get_parameter("z_max", 0.05);
992  z_rand_ = this->declare_or_get_parameter("z_rand", 0.5);
993  z_short_ = this->declare_or_get_parameter("z_short", 0.05);
994  first_map_only_ = this->declare_or_get_parameter("first_map_only", false);
995  always_reset_initial_pose_ = this->declare_or_get_parameter("always_reset_initial_pose", false);
996  scan_topic_ = this->declare_or_get_parameter("scan_topic", std::string{"scan"});
997  map_topic_ = this->declare_or_get_parameter("map_topic", std::string{"map"});
998  freespace_downsampling_ = this->declare_or_get_parameter("freespace_downsampling", false);
999  allow_parameter_qos_overrides_ = this->declare_or_get_parameter(
1000  "allow_parameter_qos_overrides", true);
1001  random_seed_ = this->declare_or_get_parameter("random_seed", -1);
1002 
1003  transform_tolerance_ = tf2::durationFromSec(tmp_tol);
1004  last_time_printed_msg_ = now();
1005 
1006  // Semantic checks
1007  if (laser_likelihood_max_dist_ < 0) {
1008  RCLCPP_WARN(
1009  get_logger(), "You've set laser_likelihood_max_dist to be negative,"
1010  " this isn't allowed so it will be set to default value 2.0.");
1011  laser_likelihood_max_dist_ = 2.0;
1012  }
1013  if (max_particles_ < 0) {
1014  RCLCPP_WARN(
1015  get_logger(), "You've set max_particles to be negative,"
1016  " this isn't allowed so it will be set to default value 2000.");
1017  max_particles_ = 2000;
1018  }
1019 
1020  if (min_particles_ < 0) {
1021  RCLCPP_WARN(
1022  get_logger(), "You've set min_particles to be negative,"
1023  " this isn't allowed so it will be set to default value 500.");
1024  min_particles_ = 500;
1025  }
1026 
1027  if (min_particles_ > max_particles_) {
1028  RCLCPP_WARN(
1029  get_logger(), "You've set min_particles to be greater than max particles,"
1030  " this isn't allowed so max_particles will be set to min_particles.");
1031  max_particles_ = min_particles_;
1032  }
1033 
1034  if (resample_interval_ <= 0) {
1035  RCLCPP_WARN(
1036  get_logger(), "You've set resample_interval to be zero or negative,"
1037  " this isn't allowed so it will be set to default value to 1.");
1038  resample_interval_ = 1;
1039  }
1040 
1041  if (always_reset_initial_pose_) {
1042  initial_pose_is_known_ = false;
1043  }
1044 }
1045 
1046 rcl_interfaces::msg::SetParametersResult AmclNode::validateParameterUpdatesCallback(
1047  const std::vector<rclcpp::Parameter> & parameters)
1048 {
1049  rcl_interfaces::msg::SetParametersResult result;
1050  result.successful = true;
1051  for (const auto & parameter : parameters) {
1052  const auto & param_type = parameter.get_type();
1053  const auto & param_name = parameter.get_name();
1054  if (param_name.find('.') != std::string::npos) {
1055  continue;
1056  }
1057  if (param_type == ParameterType::PARAMETER_DOUBLE) {
1058  if (param_name == "save_pose_rate") {
1059  // All values are valid
1060  continue;
1061  } else if (parameter.as_double() < 0.0 && // NOLINT(readability/braces)
1062  (param_name != "laser_min_range" || param_name != "laser_max_range"))
1063  {
1064  RCLCPP_WARN(
1065  get_logger(), "The value of parameter '%s' is incorrectly set to %f, "
1066  "it should be >=0. Ignoring parameter update.",
1067  param_name.c_str(), parameter.as_double());
1068  result.successful = false;
1069  }
1070  } else if (param_type == ParameterType::PARAMETER_INTEGER) {
1071  if (parameter.as_int() <= 0.0 && param_name == "resample_interval") {
1072  RCLCPP_WARN(
1073  get_logger(), "The value of resample_interval is incorrectly set, "
1074  "it should be >0. Ignoring parameter update.");
1075  result.successful = false;
1076  } else if (parameter.as_int() < 0.0) {
1077  RCLCPP_WARN(
1078  get_logger(), "The value of parameter '%s' is incorrectly set to %ld, "
1079  "it should be >=0. Ignoring parameter update.",
1080  param_name.c_str(), parameter.as_int());
1081  result.successful = false;
1082  } else if (param_name == "max_particles" && parameter.as_int() < min_particles_) {
1083  RCLCPP_WARN(
1084  get_logger(), "The value of max_particles is incorrectly set, "
1085  "it should be larger than min_particles. Ignoring parameter update.");
1086  result.successful = false;
1087  } else if (param_name == "min_particles" && parameter.as_int() > max_particles_) {
1088  RCLCPP_WARN(
1089  get_logger(), "The value of min_particles is incorrectly set, "
1090  "it should be smaller than max particles. Ignoring parameter update.");
1091  result.successful = false;
1092  }
1093  }
1094  }
1095  return result;
1096 }
1097 
1098 void
1099 AmclNode::updateParametersCallback(
1100  const std::vector<rclcpp::Parameter> & parameters)
1101 {
1102  std::lock_guard<std::recursive_mutex> cfl(mutex_);
1103 
1104  bool reinit_pf = false;
1105  bool reinit_odom = false;
1106  bool reinit_laser = false;
1107  bool reinit_map = false;
1108 
1109  for (const auto & parameter : parameters) {
1110  const auto & param_type = parameter.get_type();
1111  const auto & param_name = parameter.get_name();
1112  if (param_name.find('.') != std::string::npos) {
1113  continue;
1114  }
1115  if (param_type == ParameterType::PARAMETER_DOUBLE) {
1116  if (param_name == "alpha1") {
1117  alpha1_ = parameter.as_double();
1118  reinit_odom = true;
1119  } else if (param_name == "alpha2") {
1120  alpha2_ = parameter.as_double();
1121  reinit_odom = true;
1122  } else if (param_name == "alpha3") {
1123  alpha3_ = parameter.as_double();
1124  reinit_odom = true;
1125  } else if (param_name == "alpha4") {
1126  alpha4_ = parameter.as_double();
1127  reinit_odom = true;
1128  } else if (param_name == "alpha5") {
1129  alpha5_ = parameter.as_double();
1130  reinit_odom = true;
1131  } else if (param_name == "beam_skip_distance") {
1132  beam_skip_distance_ = parameter.as_double();
1133  reinit_laser = true;
1134  } else if (param_name == "beam_skip_error_threshold") {
1135  beam_skip_error_threshold_ = parameter.as_double();
1136  reinit_laser = true;
1137  } else if (param_name == "beam_skip_threshold") {
1138  beam_skip_threshold_ = parameter.as_double();
1139  reinit_laser = true;
1140  } else if (param_name == "lambda_short") {
1141  lambda_short_ = parameter.as_double();
1142  reinit_laser = true;
1143  } else if (param_name == "laser_likelihood_max_dist") {
1144  laser_likelihood_max_dist_ = parameter.as_double();
1145  reinit_laser = true;
1146  } else if (param_name == "laser_max_range") {
1147  laser_max_range_ = parameter.as_double();
1148  reinit_laser = true;
1149  } else if (param_name == "laser_min_range") {
1150  laser_min_range_ = parameter.as_double();
1151  reinit_laser = true;
1152  } else if (param_name == "pf_err") {
1153  pf_err_ = parameter.as_double();
1154  reinit_pf = true;
1155  } else if (param_name == "pf_z") {
1156  pf_z_ = parameter.as_double();
1157  reinit_pf = true;
1158  } else if (param_name == "recovery_alpha_fast") {
1159  alpha_fast_ = parameter.as_double();
1160  reinit_pf = true;
1161  } else if (param_name == "recovery_alpha_slow") {
1162  alpha_slow_ = parameter.as_double();
1163  reinit_pf = true;
1164  } else if (param_name == "save_pose_rate") {
1165  save_pose_rate_ = parameter.as_double();
1166  } else if (param_name == "sigma_hit") {
1167  sigma_hit_ = parameter.as_double();
1168  reinit_laser = true;
1169  } else if (param_name == "transform_tolerance") {
1170  double tmp_tol = parameter.as_double();
1171  transform_tolerance_ = tf2::durationFromSec(tmp_tol);
1172  reinit_laser = true;
1173  } else if (param_name == "update_min_a") {
1174  a_thresh_ = parameter.as_double();
1175  } else if (param_name == "update_min_d") {
1176  d_thresh_ = parameter.as_double();
1177  } else if (param_name == "z_hit") {
1178  z_hit_ = parameter.as_double();
1179  reinit_laser = true;
1180  } else if (param_name == "z_max") {
1181  z_max_ = parameter.as_double();
1182  reinit_laser = true;
1183  } else if (param_name == "z_rand") {
1184  z_rand_ = parameter.as_double();
1185  reinit_laser = true;
1186  } else if (param_name == "z_short") {
1187  z_short_ = parameter.as_double();
1188  reinit_laser = true;
1189  }
1190  } else if (param_type == ParameterType::PARAMETER_STRING) {
1191  if (param_name == "base_frame_id") {
1192  base_frame_id_ = parameter.as_string();
1193  } else if (param_name == "global_frame_id") {
1194  global_frame_id_ = parameter.as_string();
1195  } else if (param_name == "map_topic") {
1196  map_topic_ = parameter.as_string();
1197  reinit_map = true;
1198  } else if (param_name == "laser_model_type") {
1199  sensor_model_type_ = parameter.as_string();
1200  reinit_laser = true;
1201  } else if (param_name == "odom_frame_id") {
1202  odom_frame_id_ = parameter.as_string();
1203  reinit_laser = true;
1204  } else if (param_name == "scan_topic") {
1205  scan_topic_ = parameter.as_string();
1206  reinit_laser = true;
1207  } else if (param_name == "robot_model_type") {
1208  robot_model_type_ = parameter.as_string();
1209  reinit_odom = true;
1210  } else if (param_name == "saved_pose_filepath") {
1211  saved_pose_filepath_ = parameter.as_string();
1212  }
1213  } else if (param_type == ParameterType::PARAMETER_BOOL) {
1214  if (param_name == "do_beamskip") {
1215  do_beamskip_ = parameter.as_bool();
1216  reinit_laser = true;
1217  } else if (param_name == "tf_broadcast") {
1218  tf_broadcast_ = parameter.as_bool();
1219  } else if (param_name == "set_initial_pose") {
1220  set_initial_pose_ = parameter.as_bool();
1221  } else if (param_name == "first_map_only") {
1222  first_map_only_ = parameter.as_bool();
1223  } else if (param_name == "initialize_at_saved_pose") {
1224  initialize_at_saved_pose_ = parameter.as_bool();
1225  }
1226  } else if (param_type == ParameterType::PARAMETER_INTEGER) {
1227  if (param_name == "max_beams") {
1228  max_beams_ = parameter.as_int();
1229  reinit_laser = true;
1230  } else if (param_name == "max_particles") {
1231  max_particles_ = parameter.as_int();
1232  reinit_pf = true;
1233  } else if (param_name == "min_particles") {
1234  min_particles_ = parameter.as_int();
1235  reinit_pf = true;
1236  } else if (param_name == "resample_interval") {
1237  resample_interval_ = parameter.as_int();
1238  }
1239  }
1240  }
1241 
1242  // Re-initialize the particle filter
1243  if (reinit_pf) {
1244  if (pf_ != NULL) {
1245  pf_free(pf_);
1246  pf_ = NULL;
1247  }
1248  initParticleFilter();
1249  }
1250 
1251  // Re-initialize the odometry
1252  if (reinit_odom) {
1253  motion_model_.reset();
1254  initOdometry();
1255  }
1256 
1257  // Re-initialize the lasers and it's filters
1258  if (reinit_laser) {
1259  lasers_.clear();
1260  lasers_update_.clear();
1261  frame_to_laser_.clear();
1262  laser_scan_connection_.disconnect();
1263  laser_scan_filter_.reset();
1264  laser_scan_sub_.reset();
1265 
1266  initMessageFilters();
1267  }
1268 
1269  // Re-initialize the map
1270  if (reinit_map) {
1271  map_sub_.reset();
1272  map_sub_ = create_subscription<nav_msgs::msg::OccupancyGrid>(
1273  map_topic_,
1274  std::bind(&AmclNode::mapReceived, this, std::placeholders::_1),
1276  }
1277 }
1278 
1279 void
1280 AmclNode::mapReceived(const nav_msgs::msg::OccupancyGrid::ConstSharedPtr & msg)
1281 {
1282  RCLCPP_DEBUG(get_logger(), "AmclNode: A new map was received.");
1283  if (!nav2::validateMsg(*msg)) {
1284  RCLCPP_ERROR(get_logger(), "Received map message is malformed. Rejecting.");
1285  return;
1286  }
1287  if (first_map_only_ && first_map_received_) {
1288  return;
1289  }
1290  handleMapMessage(*msg);
1291  first_map_received_ = true;
1292 }
1293 
1294 void
1295 AmclNode::handleMapMessage(const nav_msgs::msg::OccupancyGrid & msg)
1296 {
1297  std::lock_guard<std::recursive_mutex> cfl(mutex_);
1298 
1299  RCLCPP_INFO(
1300  get_logger(), "Received a %d X %d map @ %.3f m/pix",
1301  msg.info.width,
1302  msg.info.height,
1303  msg.info.resolution);
1304  if (msg.header.frame_id != global_frame_id_) {
1305  RCLCPP_WARN(
1306  get_logger(), "Frame_id of map received:'%s' doesn't match global_frame_id:'%s'. This could"
1307  " cause issues with reading published topics",
1308  msg.header.frame_id.c_str(),
1309  global_frame_id_.c_str());
1310  }
1311  freeMapDependentMemory();
1312  map_ = convertMap(msg);
1313 
1314 #if NEW_UNIFORM_SAMPLING
1315  createFreeSpaceVector();
1316 #endif
1317 }
1318 
1319 void
1320 AmclNode::createFreeSpaceVector()
1321 {
1322  int delta = freespace_downsampling_ ? 2 : 1;
1323  // Index of free space
1324  free_space_indices.resize(0);
1325  for (int i = 0; i < map_->size_x; i += delta) {
1326  for (int j = 0; j < map_->size_y; j += delta) {
1327  if (map_->cells[MAP_INDEX(map_, i, j)].occ_state == -1) {
1328  AmclNode::Point2D point = {i, j};
1329  free_space_indices.push_back(point);
1330  }
1331  }
1332  }
1333 }
1334 
1335 void
1336 AmclNode::freeMapDependentMemory()
1337 {
1338  if (map_ != NULL) {
1339  map_free(map_);
1340  map_ = NULL;
1341  }
1342 
1343  // Clear queued laser objects because they hold pointers to the existing
1344  // map, #5202.
1345  lasers_.clear();
1346  lasers_update_.clear();
1347  frame_to_laser_.clear();
1348 }
1349 
1350 // Convert an OccupancyGrid map message into the internal representation. This function
1351 // allocates a map_t and returns it.
1352 map_t *
1353 AmclNode::convertMap(const nav_msgs::msg::OccupancyGrid & map_msg)
1354 {
1355  map_t * map = map_alloc();
1356 
1357  map->size_x = map_msg.info.width;
1358  map->size_y = map_msg.info.height;
1359  map->scale = map_msg.info.resolution;
1360  map->origin_x = map_msg.info.origin.position.x + (map->size_x / 2) * map->scale;
1361  map->origin_y = map_msg.info.origin.position.y + (map->size_y / 2) * map->scale;
1362 
1363  map->cells =
1364  reinterpret_cast<map_cell_t *>(malloc(sizeof(map_cell_t) * map->size_x * map->size_y));
1365 
1366  // Convert to player format
1367  for (int i = 0; i < map->size_x * map->size_y; i++) {
1368  if (map_msg.data[i] == 0) {
1369  map->cells[i].occ_state = -1;
1370  } else if (map_msg.data[i] == 100) {
1371  map->cells[i].occ_state = +1;
1372  } else {
1373  map->cells[i].occ_state = 0;
1374  }
1375  }
1376 
1377  return map;
1378 }
1379 
1380 void
1381 AmclNode::initTransforms()
1382 {
1383  RCLCPP_INFO(get_logger(), "initTransforms");
1384 
1385  // Initialize transform listener and broadcaster
1386  tf_buffer_ = nav2::create_transform_buffer(this, callback_group_);
1387  tf_listener_ = nav2::create_transform_listener(*tf_buffer_, this, true);
1388  tf_broadcaster_ = nav2::create_transform_broadcaster(shared_from_this());
1389 
1390  sent_first_transform_ = false;
1391  latest_tf_valid_ = false;
1392  latest_tf_ = tf2::Transform::getIdentity();
1393 }
1394 
1395 void
1396 AmclNode::initMessageFilters()
1397 {
1398  auto sub_opt = nav2::interfaces::createSubscriptionOptions(
1399  scan_topic_, allow_parameter_qos_overrides_);
1400 
1401  #if RCLCPP_VERSION_GTE(29, 6, 0)
1402  laser_scan_sub_ = std::make_unique<message_filters::Subscriber<sensor_msgs::msg::LaserScan>>(
1403  shared_from_this(), scan_topic_, nav2::qos::SensorDataQoS(), sub_opt);
1404  #else
1405  laser_scan_sub_ = std::make_unique<message_filters::Subscriber<sensor_msgs::msg::LaserScan,
1406  rclcpp_lifecycle::LifecycleNode>>(
1407  std::static_pointer_cast<rclcpp_lifecycle::LifecycleNode>(shared_from_this()),
1408  scan_topic_, nav2::qos::SensorDataQoS().get_rmw_qos_profile(), sub_opt);
1409  #endif
1410 
1411  laser_scan_filter_ = nav2::create_message_filter<sensor_msgs::msg::LaserScan>(
1412  *laser_scan_sub_, *tf_buffer_, odom_frame_id_, 10,
1413  this, transform_tolerance_);
1414 
1415 
1416  laser_scan_connection_ = laser_scan_filter_->registerCallback(
1417  std::bind(&AmclNode::laserReceived, this, std::placeholders::_1));
1418 }
1419 
1420 void
1421 AmclNode::initPubSub()
1422 {
1423  RCLCPP_INFO(get_logger(), "initPubSub");
1424 
1425  particle_cloud_pub_ = create_publisher<nav2_msgs::msg::ParticleCloud>(
1426  "particle_cloud",
1428 
1429  pose_pub_ = create_publisher<geometry_msgs::msg::PoseWithCovarianceStamped>(
1430  "amcl_pose",
1432 
1433  initial_pose_sub_ = create_subscription<geometry_msgs::msg::PoseWithCovarianceStamped>(
1434  "initialpose",
1435  std::bind(&AmclNode::initialPoseReceived, this, std::placeholders::_1));
1436 
1437  map_sub_ = create_subscription<nav_msgs::msg::OccupancyGrid>(
1438  map_topic_,
1439  std::bind(&AmclNode::mapReceived, this, std::placeholders::_1),
1441 
1442  RCLCPP_INFO(get_logger(), "Subscribed to map topic.");
1443 }
1444 
1445 void
1446 AmclNode::initServices()
1447 {
1448  global_loc_srv_ = create_service<std_srvs::srv::Empty>(
1449  "reinitialize_global_localization",
1450  std::bind(
1451  &AmclNode::globalLocalizationCallback, this, std::placeholders::_1,
1452  std::placeholders::_2, std::placeholders::_3));
1453 
1454  initial_guess_srv_ = create_service<nav2_msgs::srv::SetInitialPose>(
1455  "set_initial_pose",
1456  std::bind(
1457  &AmclNode::initialPoseReceivedSrv, this, std::placeholders::_1, std::placeholders::_2,
1458  std::placeholders::_3));
1459 
1460  nomotion_update_srv_ = create_service<std_srvs::srv::Empty>(
1461  "request_nomotion_update",
1462  std::bind(
1463  &AmclNode::nomotionUpdateCallback, this, std::placeholders::_1, std::placeholders::_2,
1464  std::placeholders::_3));
1465 }
1466 
1467 void
1468 AmclNode::initOdometry()
1469 {
1470  // TODO(mjeronimo): We should handle persistence of the last known pose of the robot. We could
1471  // then read that pose here and initialize using that.
1472 
1473  // When pausing and resuming, remember the last robot pose so we don't start at 0:0 again
1474  init_pose_[0] = last_published_pose_.pose.pose.position.x;
1475  init_pose_[1] = last_published_pose_.pose.pose.position.y;
1476  init_pose_[2] = tf2::getYaw(last_published_pose_.pose.pose.orientation);
1477 
1478  if (!initial_pose_is_known_) {
1479  init_cov_[0] = 0.5 * 0.5;
1480  init_cov_[1] = 0.5 * 0.5;
1481  init_cov_[2] = (M_PI / 12.0) * (M_PI / 12.0);
1482  } else {
1483  init_cov_[0] = last_published_pose_.pose.covariance[0];
1484  init_cov_[1] = last_published_pose_.pose.covariance[7];
1485  init_cov_[2] = last_published_pose_.pose.covariance[35];
1486  }
1487 
1488  motion_model_ = plugin_loader_.createSharedInstance(robot_model_type_);
1489  motion_model_->initialize(alpha1_, alpha2_, alpha3_, alpha4_, alpha5_);
1490 
1491  latest_odom_pose_ = geometry_msgs::msg::PoseStamped();
1492 }
1493 
1494 void
1495 AmclNode::initParticleFilter()
1496 {
1497  // Create the particle filter
1498  pf_ = pf_alloc(
1499  min_particles_, max_particles_, alpha_slow_, alpha_fast_,
1500  (pf_init_model_fn_t)AmclNode::uniformPoseGenerator);
1501 
1502  // Seed RNG used by PF resampling and pose generation.
1503  // Keep legacy behavior (time-based) unless user explicitly sets a seed.
1504  if (random_seed_ >= 0) {
1505  // `srand48` expects a platform `long` seed. We avoid using `long` in our code and accept
1506  // truncation when seeding.
1507  srand48(static_cast<int>(random_seed_));
1508  } else {
1509  srand48(static_cast<int>(std::time(nullptr)));
1510  }
1511 
1512  pf_->pop_err = pf_err_;
1513  pf_->pop_z = pf_z_;
1514 
1515  // Initialize the filter
1516  pf_vector_t pf_init_pose_mean = pf_vector_zero();
1517  pf_init_pose_mean.v[0] = init_pose_[0];
1518  pf_init_pose_mean.v[1] = init_pose_[1];
1519  pf_init_pose_mean.v[2] = init_pose_[2];
1520 
1521  pf_matrix_t pf_init_pose_cov = pf_matrix_zero();
1522  pf_init_pose_cov.m[0][0] = init_cov_[0];
1523  pf_init_pose_cov.m[1][1] = init_cov_[1];
1524  pf_init_pose_cov.m[2][2] = init_cov_[2];
1525 
1526  pf_init(pf_, pf_init_pose_mean, pf_init_pose_cov);
1527 
1528  pf_init_ = false;
1529  resample_count_ = 0;
1530  memset(&pf_odom_pose_, 0, sizeof(pf_odom_pose_));
1531 }
1532 
1533 void
1534 AmclNode::initLaserScan()
1535 {
1536  scan_error_count_ = 0;
1537  last_laser_received_ts_ = rclcpp::Time(0);
1538 }
1539 
1540 void
1541 AmclNode::savePoseTimerCallback()
1542 {
1543  if (!active_ || !first_pose_sent_) {
1544  return;
1545  }
1546  savePoseToFile();
1547 }
1548 
1549 void
1550 AmclNode::savePoseToFile()
1551 {
1552  std::string tmp_path = saved_pose_filepath_ + ".tmp";
1553  try {
1554  std::ofstream file(tmp_path);
1555  if (!file.is_open()) {
1556  RCLCPP_WARN(
1557  get_logger(), "Failed to open pose file for writing: %s",
1558  tmp_path.c_str());
1559  return;
1560  }
1561 
1562  auto & pose = last_published_pose_;
1563  double timestamp = pose.header.stamp.sec +
1564  static_cast<double>(pose.header.stamp.nanosec) / 1e9;
1565  file << std::fixed << std::setprecision(9);
1566  file << "timestamp: " << timestamp << "\n";
1567  file << "frame_id: " << pose.header.frame_id << "\n";
1568  file << std::setprecision(6);
1569  file << "x: " << pose.pose.pose.position.x << "\n";
1570  file << "y: " << pose.pose.pose.position.y << "\n";
1571  file << "z: " << pose.pose.pose.position.z << "\n";
1572  file << "yaw: " << tf2::getYaw(pose.pose.pose.orientation) << "\n";
1573  file.close();
1574 
1575  // Atomic rename
1576  if (std::rename(tmp_path.c_str(), saved_pose_filepath_.c_str()) != 0) {
1577  RCLCPP_WARN(
1578  get_logger(), "Failed to rename pose file from %s to %s",
1579  tmp_path.c_str(), saved_pose_filepath_.c_str());
1580  }
1581  } catch (const std::exception & e) {
1582  RCLCPP_WARN(get_logger(), "Failed to save pose to file: %s", e.what());
1583  }
1584 }
1585 
1586 bool
1587 AmclNode::loadPoseFromFile(geometry_msgs::msg::PoseWithCovarianceStamped & pose)
1588 {
1589  std::ifstream file(saved_pose_filepath_);
1590  if (!file.is_open()) {
1591  return false;
1592  }
1593 
1594  try {
1595  std::string line;
1596  double x = 0.0, y = 0.0, z = 0.0, yaw = 0.0;
1597  double timestamp = 0.0;
1598  std::string frame_id;
1599 
1600  while (std::getline(file, line)) {
1601  if (line.empty() || line[0] == '#') {
1602  continue;
1603  }
1604  std::istringstream iss(line);
1605  std::string key;
1606  if (std::getline(iss, key, ':')) {
1607  if (key == "frame_id") {
1608  iss >> std::ws;
1609  std::getline(iss, frame_id);
1610  } else {
1611  double value;
1612  iss >> value;
1613  if (key == "x") {
1614  x = value;
1615  } else if (key == "y") {
1616  y = value;
1617  } else if (key == "z") {
1618  z = value;
1619  } else if (key == "yaw") {
1620  yaw = value;
1621  } else if (key == "timestamp") {
1622  timestamp = value;
1623  }
1624  }
1625  }
1626  }
1627 
1628  pose.header.frame_id = frame_id.empty() ? global_frame_id_ : frame_id;
1629  pose.header.stamp = now(); // Always use current time for relocalization
1630  pose.pose.pose.position.x = x;
1631  pose.pose.pose.position.y = y;
1632  pose.pose.pose.position.z = z;
1633  pose.pose.pose.orientation = orientationAroundZAxis(yaw);
1634 
1635  RCLCPP_INFO(
1636  get_logger(),
1637  "Loaded saved pose from file: x=%.3f, y=%.3f, z=%.3f, yaw=%.3f, "
1638  "originally saved at timestamp=%.3f, frame=%s",
1639  x, y, z, yaw, timestamp, pose.header.frame_id.c_str());
1640 
1641  return true;
1642  } catch (const std::exception & e) {
1643  RCLCPP_WARN(get_logger(), "Failed to parse saved pose file: %s", e.what());
1644  return false;
1645  }
1646 }
1647 
1648 } // namespace nav2_amcl
1649 
1650 #include "rclcpp_components/register_node_macro.hpp"
1651 
1652 // Register the component with class_loader.
1653 // This acts as a sort of entry point, allowing the component to be discoverable when its library
1654 // is being loaded into a running process.
1655 RCLCPP_COMPONENTS_REGISTER_NODE(nav2_amcl::AmclNode)
A QoS profile for latched, reliable topics with a history of 1 messages.
A QoS profile for latched, reliable topics with a history of 10 messages.
A QoS profile for best-effort sensor data with a history of 10 messages.
Definition: map.hpp:62