Nav2 Navigation Stack - lyrical  lyrical
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  RCLCPP_INFO(get_logger(), "Initializing with uniform distribution");
369 
370  pf_init_model(
371  pf_, (pf_init_model_fn_t)AmclNode::uniformPoseGenerator,
372  reinterpret_cast<void *>(map_));
373  RCLCPP_INFO(get_logger(), "Global initialisation done!");
374  initial_pose_is_known_ = true;
375  pf_init_ = false;
376 }
377 
378 void
379 AmclNode::initialPoseReceivedSrv(
380  const std::shared_ptr<rmw_request_id_t>/*request_header*/,
381  const std::shared_ptr<nav2_msgs::srv::SetInitialPose::Request> req,
382  std::shared_ptr<nav2_msgs::srv::SetInitialPose::Response>/*res*/)
383 {
384  initialPoseReceived(std::make_shared<geometry_msgs::msg::PoseWithCovarianceStamped>(req->pose));
385 }
386 
387 // force nomotion updates (amcl updating without requiring motion)
388 void
389 AmclNode::nomotionUpdateCallback(
390  const std::shared_ptr<rmw_request_id_t>/*request_header*/,
391  const std::shared_ptr<std_srvs::srv::Empty::Request>/*req*/,
392  std::shared_ptr<std_srvs::srv::Empty::Response>/*res*/)
393 {
394  RCLCPP_INFO(get_logger(), "Requesting no-motion update");
395  force_update_ = true;
396 }
397 
398 void
399 AmclNode::initialPoseReceived(
400  const geometry_msgs::msg::PoseWithCovarianceStamped::ConstSharedPtr & msg)
401 {
402  std::lock_guard<std::recursive_mutex> cfl(mutex_);
403 
404  RCLCPP_INFO(get_logger(), "initialPoseReceived");
405 
406  if (!nav2::validateMsg(*msg)) {
407  RCLCPP_ERROR(get_logger(), "Received initialpose message is malformed. Rejecting.");
408  return;
409  }
410  if (msg->header.frame_id != global_frame_id_) {
411  RCLCPP_WARN(
412  get_logger(),
413  "Ignoring initial pose in frame \"%s\"; initial poses must be in the global frame, \"%s\"",
414  msg->header.frame_id.c_str(),
415  global_frame_id_.c_str());
416  return;
417  }
418  if (first_map_received_ && (abs(msg->pose.pose.position.x) > map_->size_x ||
419  abs(msg->pose.pose.position.y) > map_->size_y))
420  {
421  RCLCPP_ERROR(
422  get_logger(), "Received initialpose from message is out of the size of map. Rejecting.");
423  return;
424  }
425 
426  // Overriding last published pose to initial pose
427  last_published_pose_ = *msg;
428 
429  if (!active_) {
430  init_pose_received_on_inactive = true;
431  RCLCPP_WARN(
432  get_logger(), "Received initial pose request, "
433  "but AMCL is not yet in the active state");
434  return;
435  }
436  handleInitialPose(last_published_pose_);
437 }
438 
439 void
440 AmclNode::handleInitialPose(geometry_msgs::msg::PoseWithCovarianceStamped & msg)
441 {
442  std::lock_guard<std::recursive_mutex> cfl(mutex_);
443  // In case the client sent us a pose estimate in the past, integrate the
444  // intervening odometric change.
445  geometry_msgs::msg::TransformStamped tx_odom;
446  try {
447  rclcpp::Time rclcpp_time = now();
448  tf2::TimePoint tf2_time(std::chrono::nanoseconds(rclcpp_time.nanoseconds()));
449 
450  // Check if the transform is available
451  tx_odom = tf_buffer_->lookupTransform(
452  base_frame_id_, tf2_ros::fromMsg(msg.header.stamp),
453  base_frame_id_, tf2_time, odom_frame_id_);
454  } catch (tf2::TransformException & e) {
455  // If we've never sent a transform, then this is normal, because the
456  // global_frame_id_ frame doesn't exist. We only care about in-time
457  // transformation for on-the-move pose-setting, so ignoring this
458  // startup condition doesn't really cost us anything.
459  if (sent_first_transform_) {
460  RCLCPP_WARN(get_logger(), "Failed to transform initial pose in time (%s)", e.what());
461  }
462  tf2::impl::Converter<false, true>::convert(tf2::Transform::getIdentity(), tx_odom.transform);
463  }
464 
465  tf2::Transform tx_odom_tf2;
466  tf2::impl::Converter<true, false>::convert(tx_odom.transform, tx_odom_tf2);
467 
468  tf2::Transform pose_old;
469  tf2::impl::Converter<true, false>::convert(msg.pose.pose, pose_old);
470 
471  tf2::Transform pose_new = pose_old * tx_odom_tf2;
472 
473  // Transform into the global frame
474 
475  RCLCPP_INFO(
476  get_logger(), "Setting pose (%.6f): %.3f %.3f %.3f",
477  now().nanoseconds() * 1e-9,
478  pose_new.getOrigin().x(),
479  pose_new.getOrigin().y(),
480  tf2::getYaw(pose_new.getRotation()));
481 
482  // Re-initialize the filter
483  pf_vector_t pf_init_pose_mean = pf_vector_zero();
484  pf_init_pose_mean.v[0] = pose_new.getOrigin().x();
485  pf_init_pose_mean.v[1] = pose_new.getOrigin().y();
486  pf_init_pose_mean.v[2] = tf2::getYaw(pose_new.getRotation());
487 
488  pf_matrix_t pf_init_pose_cov = pf_matrix_zero();
489  // Copy in the covariance, converting from 6-D to 3-D
490  for (int i = 0; i < 2; i++) {
491  for (int j = 0; j < 2; j++) {
492  pf_init_pose_cov.m[i][j] = msg.pose.covariance[6 * i + j];
493  }
494  }
495 
496  pf_init_pose_cov.m[2][2] = msg.pose.covariance[6 * 5 + 5];
497 
498  pf_init(pf_, pf_init_pose_mean, pf_init_pose_cov);
499  pf_init_ = false;
500  init_pose_received_on_inactive = false;
501  initial_pose_is_known_ = true;
502 }
503 
504 void
505 AmclNode::laserReceived(sensor_msgs::msg::LaserScan::ConstSharedPtr laser_scan)
506 {
507  std::lock_guard<std::recursive_mutex> cfl(mutex_);
508 
509  // Since the sensor data is continually being published by the simulator or robot,
510  // we don't want our callbacks to fire until we're in the active state
511  if (!active_) {return;}
512  if (!first_map_received_) {
513  if (checkElapsedTime(2s, last_time_printed_msg_)) {
514  RCLCPP_WARN(get_logger(), "Waiting for map....");
515  last_time_printed_msg_ = now();
516  }
517  return;
518  }
519 
520  std::string laser_scan_frame_id = laser_scan->header.frame_id;
521  last_laser_received_ts_ = now();
522  int laser_index = -1;
523  geometry_msgs::msg::PoseStamped laser_pose;
524 
525  // Do we have the base->base_laser Tx yet?
526  if (frame_to_laser_.find(laser_scan_frame_id) == frame_to_laser_.end()) {
527  if (!addNewScanner(laser_index, laser_scan, laser_scan_frame_id, laser_pose)) {
528  return; // could not find transform
529  }
530  } else {
531  // we have the laser pose, retrieve laser index
532  laser_index = frame_to_laser_[laser_scan->header.frame_id];
533  }
534 
535  // Where was the robot when this scan was taken?
536  pf_vector_t pose;
537  if (!getOdomPose(
538  latest_odom_pose_, pose.v[0], pose.v[1], pose.v[2],
539  laser_scan->header.stamp, base_frame_id_))
540  {
541  RCLCPP_ERROR(get_logger(), "Couldn't determine robot's pose associated with laser scan");
542  return;
543  }
544 
545  pf_vector_t delta = pf_vector_zero();
546  bool force_publication = false;
547  if (!pf_init_) {
548  // Pose at last filter update
549  pf_odom_pose_ = pose;
550  pf_init_ = true;
551 
552  for (unsigned int i = 0; i < lasers_update_.size(); i++) {
553  lasers_update_[i] = true;
554  }
555 
556  force_publication = true;
557  resample_count_ = 0;
558  } else {
559  // Set the laser update flags
560  if (shouldUpdateFilter(pose, delta)) {
561  for (unsigned int i = 0; i < lasers_update_.size(); i++) {
562  lasers_update_[i] = true;
563  }
564  }
565  if (lasers_update_[laser_index]) {
566  motion_model_->odometryUpdate(pf_, pose, delta);
567  }
568  force_update_ = false;
569  }
570 
571  bool resampled = false;
572 
573  // If the robot has moved, update the filter
574  if (lasers_update_[laser_index]) {
575  updateFilter(laser_index, laser_scan, pose);
576 
577  // Resample the particles
578  if (!(++resample_count_ % resample_interval_)) {
579  pf_update_resample(pf_, reinterpret_cast<void *>(map_));
580  resampled = true;
581  }
582 
583  pf_sample_set_t * set = pf_->sets + pf_->current_set;
584  RCLCPP_DEBUG(get_logger(), "Num samples: %d\n", set->sample_count);
585 
586  if (!force_update_) {
587  publishParticleCloud(set);
588  }
589  }
590  if (resampled || force_publication || !first_pose_sent_) {
591  amcl_hyp_t max_weight_hyps;
592  std::vector<amcl_hyp_t> hyps;
593  int max_weight_hyp = -1;
594  if (getMaxWeightHyp(hyps, max_weight_hyps, max_weight_hyp)) {
595  publishAmclPose(laser_scan, hyps, max_weight_hyp);
596  calculateMaptoOdomTransform(laser_scan, hyps, max_weight_hyp);
597 
598  if (tf_broadcast_ == true) {
599  // We want to send a transform that is good up until a
600  // tolerance time so that odom can be used
601  auto stamp = tf2_ros::fromMsg(laser_scan->header.stamp);
602  tf2::TimePoint transform_expiration = stamp + transform_tolerance_;
603  sendMapToOdomTransform(transform_expiration);
604  sent_first_transform_ = true;
605  }
606  } else {
607  RCLCPP_ERROR(get_logger(), "No pose!");
608  }
609  } else if (latest_tf_valid_) {
610  if (tf_broadcast_ == true) {
611  // Nothing changed, so we'll just republish the last transform, to keep
612  // everybody happy.
613  tf2::TimePoint transform_expiration = tf2_ros::fromMsg(laser_scan->header.stamp) +
614  transform_tolerance_;
615  sendMapToOdomTransform(transform_expiration);
616  }
617  }
618 }
619 
620 bool AmclNode::addNewScanner(
621  int & laser_index,
622  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
623  const std::string & laser_scan_frame_id,
624  geometry_msgs::msg::PoseStamped & laser_pose)
625 {
626  lasers_.push_back(createLaserObject());
627  lasers_update_.push_back(true);
628  laser_index = frame_to_laser_.size();
629 
630  geometry_msgs::msg::PoseStamped ident;
631  ident.header.frame_id = laser_scan_frame_id;
632  ident.header.stamp = rclcpp::Time();
633  tf2::toMsg(tf2::Transform::getIdentity(), ident.pose);
634  try {
635  tf_buffer_->transform(ident, laser_pose, base_frame_id_, transform_tolerance_);
636  } catch (tf2::TransformException & e) {
637  RCLCPP_ERROR(
638  get_logger(), "Couldn't transform from %s to %s, "
639  "even though the message notifier is in use: (%s)",
640  laser_scan->header.frame_id.c_str(),
641  base_frame_id_.c_str(), e.what());
642  return false;
643  }
644 
645  pf_vector_t laser_pose_v;
646  laser_pose_v.v[0] = laser_pose.pose.position.x;
647  laser_pose_v.v[1] = laser_pose.pose.position.y;
648  // laser mounting angle gets computed later -> set to 0 here!
649  laser_pose_v.v[2] = 0;
650  lasers_[laser_index]->SetLaserPose(laser_pose_v);
651  frame_to_laser_[laser_scan->header.frame_id] = laser_index;
652  return true;
653 }
654 
655 bool AmclNode::shouldUpdateFilter(const pf_vector_t pose, pf_vector_t & delta)
656 {
657  delta.v[0] = pose.v[0] - pf_odom_pose_.v[0];
658  delta.v[1] = pose.v[1] - pf_odom_pose_.v[1];
659  delta.v[2] = angleutils::angle_diff(pose.v[2], pf_odom_pose_.v[2]);
660 
661  // See if we should update the filter
662  bool update = fabs(delta.v[0]) > d_thresh_ ||
663  fabs(delta.v[1]) > d_thresh_ ||
664  fabs(delta.v[2]) > a_thresh_;
665  update = update || force_update_;
666  return update;
667 }
668 
669 bool AmclNode::updateFilter(
670  const int & laser_index,
671  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
672  const pf_vector_t & pose)
673 {
674  nav2_amcl::LaserData ldata;
675  ldata.laser = lasers_[laser_index].get();
676  ldata.range_count = laser_scan->ranges.size();
677  // To account for lasers that are mounted upside-down, we determine the
678  // min, max, and increment angles of the laser in the base frame.
679  //
680  // Construct min and max angles of laser, in the base_link frame.
681  // Here we set the roll pitch yaw of the lasers. We assume roll and pitch are zero.
682  geometry_msgs::msg::QuaternionStamped min_q, inc_q;
683  min_q.header.stamp = laser_scan->header.stamp;
684  min_q.header.frame_id = laser_scan->header.frame_id;
685  min_q.quaternion = orientationAroundZAxis(laser_scan->angle_min);
686 
687  inc_q.header = min_q.header;
688  inc_q.quaternion = orientationAroundZAxis(laser_scan->angle_min + laser_scan->angle_increment);
689  try {
690  tf_buffer_->transform(min_q, min_q, base_frame_id_);
691  tf_buffer_->transform(inc_q, inc_q, base_frame_id_);
692  } catch (tf2::TransformException & e) {
693  RCLCPP_WARN(
694  get_logger(), "Unable to transform min/max laser angles into base frame: %s",
695  e.what());
696  return false;
697  }
698  double angle_min = tf2::getYaw(min_q.quaternion);
699  double angle_increment = tf2::getYaw(inc_q.quaternion) - angle_min;
700 
701  // wrapping angle to [-pi .. pi]
702  angle_increment = fmod(angle_increment + 5 * M_PI, 2 * M_PI) - M_PI;
703 
704  RCLCPP_DEBUG(
705  get_logger(), "Laser %d angles in base frame: min: %.3f inc: %.3f", laser_index, angle_min,
706  angle_increment);
707 
708  // Check the validity of range_max, must > 0.0
709  if (laser_scan->range_max <= 0.0) {
710  RCLCPP_WARN(
711  get_logger(), "wrong range_max of laser_scan data: %f. The message could be malformed."
712  " Ignore this message and stop updating.",
713  laser_scan->range_max);
714  return false;
715  }
716 
717  // Apply range min/max thresholds, if the user supplied them
718  if (laser_max_range_ > 0.0) {
719  ldata.range_max = std::min(laser_scan->range_max, static_cast<float>(laser_max_range_));
720  } else {
721  ldata.range_max = laser_scan->range_max;
722  }
723  double range_min;
724  if (laser_min_range_ > 0.0) {
725  range_min = std::max(laser_scan->range_min, static_cast<float>(laser_min_range_));
726  } else {
727  range_min = laser_scan->range_min;
728  }
729 
730  // The LaserData destructor will free this memory
731  ldata.ranges = new double[ldata.range_count][2];
732  for (int i = 0; i < ldata.range_count; i++) {
733  // amcl doesn't (yet) have a concept of min range. So we'll map short
734  // readings to max range.
735  if (laser_scan->ranges[i] <= range_min) {
736  ldata.ranges[i][0] = ldata.range_max;
737  } else {
738  ldata.ranges[i][0] = laser_scan->ranges[i];
739  }
740  // Compute bearing
741  ldata.ranges[i][1] = angle_min +
742  (i * angle_increment);
743  }
744  lasers_[laser_index]->sensorUpdate(pf_, reinterpret_cast<nav2_amcl::LaserData *>(&ldata));
745  lasers_update_[laser_index] = false;
746  pf_odom_pose_ = pose;
747  return true;
748 }
749 
750 void
751 AmclNode::publishParticleCloud(const pf_sample_set_t * set)
752 {
753  // If initial pose is not known, AMCL does not know the current pose
754  if (!initial_pose_is_known_) {return;}
755  auto cloud_with_weights_msg = std::make_unique<nav2_msgs::msg::ParticleCloud>();
756  cloud_with_weights_msg->header.stamp = this->now();
757  cloud_with_weights_msg->header.frame_id = global_frame_id_;
758  cloud_with_weights_msg->particles.resize(set->sample_count);
759 
760  for (int i = 0; i < set->sample_count; i++) {
761  cloud_with_weights_msg->particles[i].pose.position.x = set->samples[i].pose.v[0];
762  cloud_with_weights_msg->particles[i].pose.position.y = set->samples[i].pose.v[1];
763  cloud_with_weights_msg->particles[i].pose.position.z = 0;
764  cloud_with_weights_msg->particles[i].pose.orientation = orientationAroundZAxis(
765  set->samples[i].pose.v[2]);
766  cloud_with_weights_msg->particles[i].weight = set->samples[i].weight;
767  }
768 
769  particle_cloud_pub_->publish(std::move(cloud_with_weights_msg));
770 }
771 
772 bool
773 AmclNode::getMaxWeightHyp(
774  std::vector<amcl_hyp_t> & hyps, amcl_hyp_t & max_weight_hyps,
775  int & max_weight_hyp)
776 {
777  // Read out the current hypotheses
778  double max_weight = 0.0;
779  hyps.resize(pf_->sets[pf_->current_set].cluster_count);
780  for (int hyp_count = 0;
781  hyp_count < pf_->sets[pf_->current_set].cluster_count; hyp_count++)
782  {
783  double weight;
784  pf_vector_t pose_mean;
785  pf_matrix_t pose_cov;
786  if (!pf_get_cluster_stats(pf_, hyp_count, &weight, &pose_mean, &pose_cov)) {
787  RCLCPP_ERROR(get_logger(), "Couldn't get stats on cluster %d", hyp_count);
788  return false;
789  }
790 
791  hyps[hyp_count].weight = weight;
792  hyps[hyp_count].pf_pose_mean = pose_mean;
793  hyps[hyp_count].pf_pose_cov = pose_cov;
794 
795  if (hyps[hyp_count].weight > max_weight) {
796  max_weight = hyps[hyp_count].weight;
797  max_weight_hyp = hyp_count;
798  }
799  }
800 
801  if (max_weight > 0.0) {
802  RCLCPP_DEBUG(
803  get_logger(), "Max weight pose: %.3f %.3f %.3f",
804  hyps[max_weight_hyp].pf_pose_mean.v[0],
805  hyps[max_weight_hyp].pf_pose_mean.v[1],
806  hyps[max_weight_hyp].pf_pose_mean.v[2]);
807 
808  max_weight_hyps = hyps[max_weight_hyp];
809  return true;
810  }
811  return false;
812 }
813 
814 void
815 AmclNode::publishAmclPose(
816  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
817  const std::vector<amcl_hyp_t> & hyps, const int & max_weight_hyp)
818 {
819  // If initial pose is not known, AMCL does not know the current pose
820  if (!initial_pose_is_known_) {
821  if (checkElapsedTime(2s, last_time_printed_msg_)) {
822  RCLCPP_WARN(
823  get_logger(), "AMCL cannot publish a pose or update the transform. "
824  "Please set the initial pose...");
825  last_time_printed_msg_ = now();
826  }
827  return;
828  }
829 
830  auto p = std::make_unique<geometry_msgs::msg::PoseWithCovarianceStamped>();
831  // Fill in the header
832  p->header.frame_id = global_frame_id_;
833  p->header.stamp = laser_scan->header.stamp;
834  // Copy in the pose
835  p->pose.pose.position.x = hyps[max_weight_hyp].pf_pose_mean.v[0];
836  p->pose.pose.position.y = hyps[max_weight_hyp].pf_pose_mean.v[1];
837  p->pose.pose.orientation = orientationAroundZAxis(hyps[max_weight_hyp].pf_pose_mean.v[2]);
838  // Copy in the covariance, converting from 3-D to 6-D
839  pf_sample_set_t * set = pf_->sets + pf_->current_set;
840  for (int i = 0; i < 2; i++) {
841  for (int j = 0; j < 2; j++) {
842  // Report the overall filter covariance, rather than the
843  // covariance for the highest-weight cluster
844  // p->covariance[6*i+j] = hyps[max_weight_hyp].pf_pose_cov.m[i][j];
845  p->pose.covariance[6 * i + j] = set->cov.m[i][j];
846  }
847  }
848  p->pose.covariance[6 * 5 + 5] = set->cov.m[2][2];
849  float temp = 0.0;
850  for (auto covariance_value : p->pose.covariance) {
851  temp += covariance_value;
852  }
853  temp += p->pose.pose.position.x + p->pose.pose.position.y;
854  if (!std::isnan(temp)) {
855  RCLCPP_DEBUG(get_logger(), "Publishing pose");
856  last_published_pose_ = *p;
857  first_pose_sent_ = true;
858  pose_pub_->publish(std::move(p));
859  } else {
860  RCLCPP_WARN(
861  get_logger(), "AMCL covariance or pose is NaN, likely due to an invalid "
862  "configuration or faulty sensor measurements! Pose is not available!");
863  }
864 
865  RCLCPP_DEBUG(
866  get_logger(), "New pose: %6.3f %6.3f %6.3f",
867  hyps[max_weight_hyp].pf_pose_mean.v[0],
868  hyps[max_weight_hyp].pf_pose_mean.v[1],
869  hyps[max_weight_hyp].pf_pose_mean.v[2]);
870 }
871 
872 void
873 AmclNode::calculateMaptoOdomTransform(
874  const sensor_msgs::msg::LaserScan::ConstSharedPtr & laser_scan,
875  const std::vector<amcl_hyp_t> & hyps, const int & max_weight_hyp)
876 {
877  // subtracting base to odom from map to base and send map to odom instead
878  geometry_msgs::msg::PoseStamped odom_to_map;
879  try {
880  tf2::Quaternion q;
881  q.setRPY(0, 0, hyps[max_weight_hyp].pf_pose_mean.v[2]);
882  tf2::Transform tmp_tf(q, tf2::Vector3(
883  hyps[max_weight_hyp].pf_pose_mean.v[0],
884  hyps[max_weight_hyp].pf_pose_mean.v[1],
885  0.0));
886 
887  geometry_msgs::msg::PoseStamped tmp_tf_stamped;
888  tmp_tf_stamped.header.frame_id = base_frame_id_;
889  tmp_tf_stamped.header.stamp = laser_scan->header.stamp;
890  tf2::toMsg(tmp_tf.inverse(), tmp_tf_stamped.pose);
891 
892  tf_buffer_->transform(tmp_tf_stamped, odom_to_map, odom_frame_id_);
893  } catch (tf2::TransformException & e) {
894  RCLCPP_DEBUG(get_logger(), "Failed to subtract base to odom transform: (%s)", e.what());
895  return;
896  }
897 
898  tf2::impl::Converter<true, false>::convert(odom_to_map.pose, latest_tf_);
899  latest_tf_valid_ = true;
900 }
901 
902 void
903 AmclNode::sendMapToOdomTransform(const tf2::TimePoint & transform_expiration)
904 {
905  // AMCL will update transform only when it has knowledge about robot's initial position
906  if (!initial_pose_is_known_) {return;}
907  geometry_msgs::msg::TransformStamped tmp_tf_stamped;
908  tmp_tf_stamped.header.frame_id = global_frame_id_;
909  tmp_tf_stamped.header.stamp = tf2_ros::toMsg(transform_expiration);
910  tmp_tf_stamped.child_frame_id = odom_frame_id_;
911  tf2::impl::Converter<false, true>::convert(latest_tf_.inverse(), tmp_tf_stamped.transform);
912  tf_broadcaster_->sendTransform(tmp_tf_stamped);
913 }
914 
915 std::unique_ptr<nav2_amcl::Laser>
916 AmclNode::createLaserObject()
917 {
918  RCLCPP_INFO(get_logger(), "createLaserObject");
919 
920  if (sensor_model_type_ == "beam") {
921  return std::make_unique<nav2_amcl::BeamModel>(
922  z_hit_, z_short_, z_max_, z_rand_, sigma_hit_, lambda_short_,
923  0.0, max_beams_, map_);
924  }
925 
926  if (sensor_model_type_ == "likelihood_field_prob") {
927  return std::make_unique<nav2_amcl::LikelihoodFieldModelProb>(
928  z_hit_, z_rand_, sigma_hit_,
929  laser_likelihood_max_dist_, do_beamskip_, beam_skip_distance_, beam_skip_threshold_,
930  beam_skip_error_threshold_, max_beams_, map_);
931  }
932 
933  return std::make_unique<nav2_amcl::LikelihoodFieldModel>(
934  z_hit_, z_rand_, sigma_hit_,
935  laser_likelihood_max_dist_, max_beams_, map_);
936 }
937 
938 void
939 AmclNode::initParameters()
940 {
941  double tmp_tol;
942 
943  alpha1_ = this->declare_or_get_parameter("alpha1", 0.2);
944  alpha2_ = this->declare_or_get_parameter("alpha2", 0.2);
945  alpha3_ = this->declare_or_get_parameter("alpha3", 0.2);
946  alpha4_ = this->declare_or_get_parameter("alpha4", 0.2);
947  alpha5_ = this->declare_or_get_parameter("alpha5", 0.2);
948  base_frame_id_ = this->declare_or_get_parameter("base_frame_id", std::string{"base_footprint"});
949  beam_skip_distance_ = this->declare_or_get_parameter("beam_skip_distance", 0.5);
950  beam_skip_error_threshold_ = this->declare_or_get_parameter("beam_skip_error_threshold", 0.9);
951  beam_skip_threshold_ = this->declare_or_get_parameter("beam_skip_threshold", 0.3);
952  do_beamskip_ = this->declare_or_get_parameter("do_beamskip", false);
953  global_frame_id_ = this->declare_or_get_parameter("global_frame_id", std::string{"map"});
954  lambda_short_ = this->declare_or_get_parameter("lambda_short", 0.1);
955  laser_likelihood_max_dist_ = this->declare_or_get_parameter("laser_likelihood_max_dist", 2.0);
956  laser_max_range_ = this->declare_or_get_parameter("laser_max_range", 100.0);
957  laser_min_range_ = this->declare_or_get_parameter("laser_min_range", -1.0);
958  sensor_model_type_ = this->declare_or_get_parameter(
959  "laser_model_type", std::string{"likelihood_field"});
960  set_initial_pose_ = this->declare_or_get_parameter("set_initial_pose", false);
961  initial_pose_x_ = this->declare_or_get_parameter("initial_pose.x", 0.0);
962  initial_pose_y_ = this->declare_or_get_parameter("initial_pose.y", 0.0);
963  initial_pose_z_ = this->declare_or_get_parameter("initial_pose.z", 0.0);
964  initial_pose_yaw_ = this->declare_or_get_parameter("initial_pose.yaw", 0.0);
965  max_beams_ = this->declare_or_get_parameter("max_beams", 60);
966  max_particles_ = this->declare_or_get_parameter("max_particles", 2000);
967  min_particles_ = this->declare_or_get_parameter("min_particles", 500);
968  odom_frame_id_ = this->declare_or_get_parameter("odom_frame_id", std::string{"odom"});
969  pf_err_ = this->declare_or_get_parameter("pf_err", 0.05);
970  pf_z_ = this->declare_or_get_parameter("pf_z", 0.99);
971  alpha_fast_ = this->declare_or_get_parameter("recovery_alpha_fast", 0.0);
972  alpha_slow_ = this->declare_or_get_parameter("recovery_alpha_slow", 0.0);
973  resample_interval_ = this->declare_or_get_parameter("resample_interval", 1);
974  robot_model_type_ = this->declare_or_get_parameter(
975  "robot_model_type", std::string{"nav2_amcl::DifferentialMotionModel"});
976  save_pose_rate_ = this->declare_or_get_parameter("save_pose_rate", 0.5);
977  initialize_at_saved_pose_ = this->declare_or_get_parameter("initialize_at_saved_pose", false);
978  saved_pose_filepath_ = this->declare_or_get_parameter(
979  "saved_pose_filepath", std::string("/tmp/amcl_saved_pose"));
980  sigma_hit_ = this->declare_or_get_parameter("sigma_hit", 0.2);
981  tf_broadcast_ = this->declare_or_get_parameter("tf_broadcast", true);
982  tmp_tol = this->declare_or_get_parameter("transform_tolerance", 1.0);
983  a_thresh_ = this->declare_or_get_parameter("update_min_a", 0.2);
984  d_thresh_ = this->declare_or_get_parameter("update_min_d", 0.25);
985  z_hit_ = this->declare_or_get_parameter("z_hit", 0.5);
986  z_max_ = this->declare_or_get_parameter("z_max", 0.05);
987  z_rand_ = this->declare_or_get_parameter("z_rand", 0.5);
988  z_short_ = this->declare_or_get_parameter("z_short", 0.05);
989  first_map_only_ = this->declare_or_get_parameter("first_map_only", false);
990  always_reset_initial_pose_ = this->declare_or_get_parameter("always_reset_initial_pose", false);
991  scan_topic_ = this->declare_or_get_parameter("scan_topic", std::string{"scan"});
992  map_topic_ = this->declare_or_get_parameter("map_topic", std::string{"map"});
993  freespace_downsampling_ = this->declare_or_get_parameter("freespace_downsampling", false);
994  allow_parameter_qos_overrides_ = this->declare_or_get_parameter(
995  "allow_parameter_qos_overrides", true);
996  random_seed_ = this->declare_or_get_parameter("random_seed", -1);
997 
998  transform_tolerance_ = tf2::durationFromSec(tmp_tol);
999  last_time_printed_msg_ = now();
1000 
1001  // Semantic checks
1002  if (laser_likelihood_max_dist_ < 0) {
1003  RCLCPP_WARN(
1004  get_logger(), "You've set laser_likelihood_max_dist to be negative,"
1005  " this isn't allowed so it will be set to default value 2.0.");
1006  laser_likelihood_max_dist_ = 2.0;
1007  }
1008  if (max_particles_ < 0) {
1009  RCLCPP_WARN(
1010  get_logger(), "You've set max_particles to be negative,"
1011  " this isn't allowed so it will be set to default value 2000.");
1012  max_particles_ = 2000;
1013  }
1014 
1015  if (min_particles_ < 0) {
1016  RCLCPP_WARN(
1017  get_logger(), "You've set min_particles to be negative,"
1018  " this isn't allowed so it will be set to default value 500.");
1019  min_particles_ = 500;
1020  }
1021 
1022  if (min_particles_ > max_particles_) {
1023  RCLCPP_WARN(
1024  get_logger(), "You've set min_particles to be greater than max particles,"
1025  " this isn't allowed so max_particles will be set to min_particles.");
1026  max_particles_ = min_particles_;
1027  }
1028 
1029  if (resample_interval_ <= 0) {
1030  RCLCPP_WARN(
1031  get_logger(), "You've set resample_interval to be zero or negative,"
1032  " this isn't allowed so it will be set to default value to 1.");
1033  resample_interval_ = 1;
1034  }
1035 
1036  if (always_reset_initial_pose_) {
1037  initial_pose_is_known_ = false;
1038  }
1039 }
1040 
1041 rcl_interfaces::msg::SetParametersResult AmclNode::validateParameterUpdatesCallback(
1042  const std::vector<rclcpp::Parameter> & parameters)
1043 {
1044  rcl_interfaces::msg::SetParametersResult result;
1045  result.successful = true;
1046  for (const auto & parameter : parameters) {
1047  const auto & param_type = parameter.get_type();
1048  const auto & param_name = parameter.get_name();
1049  if (param_name.find('.') != std::string::npos) {
1050  continue;
1051  }
1052  if (param_type == ParameterType::PARAMETER_DOUBLE) {
1053  if (param_name == "save_pose_rate") {
1054  // All values are valid
1055  continue;
1056  } else if (parameter.as_double() < 0.0 && // NOLINT(readability/braces)
1057  (param_name != "laser_min_range" || param_name != "laser_max_range"))
1058  {
1059  RCLCPP_WARN(
1060  get_logger(), "The value of parameter '%s' is incorrectly set to %f, "
1061  "it should be >=0. Ignoring parameter update.",
1062  param_name.c_str(), parameter.as_double());
1063  result.successful = false;
1064  }
1065  } else if (param_type == ParameterType::PARAMETER_INTEGER) {
1066  if (parameter.as_int() <= 0.0 && param_name == "resample_interval") {
1067  RCLCPP_WARN(
1068  get_logger(), "The value of resample_interval is incorrectly set, "
1069  "it should be >0. Ignoring parameter update.");
1070  result.successful = false;
1071  } else if (parameter.as_int() < 0.0) {
1072  RCLCPP_WARN(
1073  get_logger(), "The value of parameter '%s' is incorrectly set to %ld, "
1074  "it should be >=0. Ignoring parameter update.",
1075  param_name.c_str(), parameter.as_int());
1076  result.successful = false;
1077  } else if (param_name == "max_particles" && parameter.as_int() < min_particles_) {
1078  RCLCPP_WARN(
1079  get_logger(), "The value of max_particles is incorrectly set, "
1080  "it should be larger than min_particles. Ignoring parameter update.");
1081  result.successful = false;
1082  } else if (param_name == "min_particles" && parameter.as_int() > max_particles_) {
1083  RCLCPP_WARN(
1084  get_logger(), "The value of min_particles is incorrectly set, "
1085  "it should be smaller than max particles. Ignoring parameter update.");
1086  result.successful = false;
1087  }
1088  }
1089  }
1090  return result;
1091 }
1092 
1093 void
1094 AmclNode::updateParametersCallback(
1095  const std::vector<rclcpp::Parameter> & parameters)
1096 {
1097  std::lock_guard<std::recursive_mutex> cfl(mutex_);
1098 
1099  bool reinit_pf = false;
1100  bool reinit_odom = false;
1101  bool reinit_laser = false;
1102  bool reinit_map = false;
1103 
1104  for (const auto & parameter : parameters) {
1105  const auto & param_type = parameter.get_type();
1106  const auto & param_name = parameter.get_name();
1107  if (param_name.find('.') != std::string::npos) {
1108  continue;
1109  }
1110  if (param_type == ParameterType::PARAMETER_DOUBLE) {
1111  if (param_name == "alpha1") {
1112  alpha1_ = parameter.as_double();
1113  reinit_odom = true;
1114  } else if (param_name == "alpha2") {
1115  alpha2_ = parameter.as_double();
1116  reinit_odom = true;
1117  } else if (param_name == "alpha3") {
1118  alpha3_ = parameter.as_double();
1119  reinit_odom = true;
1120  } else if (param_name == "alpha4") {
1121  alpha4_ = parameter.as_double();
1122  reinit_odom = true;
1123  } else if (param_name == "alpha5") {
1124  alpha5_ = parameter.as_double();
1125  reinit_odom = true;
1126  } else if (param_name == "beam_skip_distance") {
1127  beam_skip_distance_ = parameter.as_double();
1128  reinit_laser = true;
1129  } else if (param_name == "beam_skip_error_threshold") {
1130  beam_skip_error_threshold_ = parameter.as_double();
1131  reinit_laser = true;
1132  } else if (param_name == "beam_skip_threshold") {
1133  beam_skip_threshold_ = parameter.as_double();
1134  reinit_laser = true;
1135  } else if (param_name == "lambda_short") {
1136  lambda_short_ = parameter.as_double();
1137  reinit_laser = true;
1138  } else if (param_name == "laser_likelihood_max_dist") {
1139  laser_likelihood_max_dist_ = parameter.as_double();
1140  reinit_laser = true;
1141  } else if (param_name == "laser_max_range") {
1142  laser_max_range_ = parameter.as_double();
1143  reinit_laser = true;
1144  } else if (param_name == "laser_min_range") {
1145  laser_min_range_ = parameter.as_double();
1146  reinit_laser = true;
1147  } else if (param_name == "pf_err") {
1148  pf_err_ = parameter.as_double();
1149  reinit_pf = true;
1150  } else if (param_name == "pf_z") {
1151  pf_z_ = parameter.as_double();
1152  reinit_pf = true;
1153  } else if (param_name == "recovery_alpha_fast") {
1154  alpha_fast_ = parameter.as_double();
1155  reinit_pf = true;
1156  } else if (param_name == "recovery_alpha_slow") {
1157  alpha_slow_ = parameter.as_double();
1158  reinit_pf = true;
1159  } else if (param_name == "save_pose_rate") {
1160  save_pose_rate_ = parameter.as_double();
1161  } else if (param_name == "sigma_hit") {
1162  sigma_hit_ = parameter.as_double();
1163  reinit_laser = true;
1164  } else if (param_name == "transform_tolerance") {
1165  double tmp_tol = parameter.as_double();
1166  transform_tolerance_ = tf2::durationFromSec(tmp_tol);
1167  reinit_laser = true;
1168  } else if (param_name == "update_min_a") {
1169  a_thresh_ = parameter.as_double();
1170  } else if (param_name == "update_min_d") {
1171  d_thresh_ = parameter.as_double();
1172  } else if (param_name == "z_hit") {
1173  z_hit_ = parameter.as_double();
1174  reinit_laser = true;
1175  } else if (param_name == "z_max") {
1176  z_max_ = parameter.as_double();
1177  reinit_laser = true;
1178  } else if (param_name == "z_rand") {
1179  z_rand_ = parameter.as_double();
1180  reinit_laser = true;
1181  } else if (param_name == "z_short") {
1182  z_short_ = parameter.as_double();
1183  reinit_laser = true;
1184  }
1185  } else if (param_type == ParameterType::PARAMETER_STRING) {
1186  if (param_name == "base_frame_id") {
1187  base_frame_id_ = parameter.as_string();
1188  } else if (param_name == "global_frame_id") {
1189  global_frame_id_ = parameter.as_string();
1190  } else if (param_name == "map_topic") {
1191  map_topic_ = parameter.as_string();
1192  reinit_map = true;
1193  } else if (param_name == "laser_model_type") {
1194  sensor_model_type_ = parameter.as_string();
1195  reinit_laser = true;
1196  } else if (param_name == "odom_frame_id") {
1197  odom_frame_id_ = parameter.as_string();
1198  reinit_laser = true;
1199  } else if (param_name == "scan_topic") {
1200  scan_topic_ = parameter.as_string();
1201  reinit_laser = true;
1202  } else if (param_name == "robot_model_type") {
1203  robot_model_type_ = parameter.as_string();
1204  reinit_odom = true;
1205  } else if (param_name == "saved_pose_filepath") {
1206  saved_pose_filepath_ = parameter.as_string();
1207  }
1208  } else if (param_type == ParameterType::PARAMETER_BOOL) {
1209  if (param_name == "do_beamskip") {
1210  do_beamskip_ = parameter.as_bool();
1211  reinit_laser = true;
1212  } else if (param_name == "tf_broadcast") {
1213  tf_broadcast_ = parameter.as_bool();
1214  } else if (param_name == "set_initial_pose") {
1215  set_initial_pose_ = parameter.as_bool();
1216  } else if (param_name == "first_map_only") {
1217  first_map_only_ = parameter.as_bool();
1218  } else if (param_name == "initialize_at_saved_pose") {
1219  initialize_at_saved_pose_ = parameter.as_bool();
1220  }
1221  } else if (param_type == ParameterType::PARAMETER_INTEGER) {
1222  if (param_name == "max_beams") {
1223  max_beams_ = parameter.as_int();
1224  reinit_laser = true;
1225  } else if (param_name == "max_particles") {
1226  max_particles_ = parameter.as_int();
1227  reinit_pf = true;
1228  } else if (param_name == "min_particles") {
1229  min_particles_ = parameter.as_int();
1230  reinit_pf = true;
1231  } else if (param_name == "resample_interval") {
1232  resample_interval_ = parameter.as_int();
1233  }
1234  }
1235  }
1236 
1237  // Re-initialize the particle filter
1238  if (reinit_pf) {
1239  if (pf_ != NULL) {
1240  pf_free(pf_);
1241  pf_ = NULL;
1242  }
1243  initParticleFilter();
1244  }
1245 
1246  // Re-initialize the odometry
1247  if (reinit_odom) {
1248  motion_model_.reset();
1249  initOdometry();
1250  }
1251 
1252  // Re-initialize the lasers and it's filters
1253  if (reinit_laser) {
1254  lasers_.clear();
1255  lasers_update_.clear();
1256  frame_to_laser_.clear();
1257  laser_scan_connection_.disconnect();
1258  laser_scan_filter_.reset();
1259  laser_scan_sub_.reset();
1260 
1261  initMessageFilters();
1262  }
1263 
1264  // Re-initialize the map
1265  if (reinit_map) {
1266  map_sub_.reset();
1267  map_sub_ = create_subscription<nav_msgs::msg::OccupancyGrid>(
1268  map_topic_,
1269  std::bind(&AmclNode::mapReceived, this, std::placeholders::_1),
1271  }
1272 }
1273 
1274 void
1275 AmclNode::mapReceived(const nav_msgs::msg::OccupancyGrid::ConstSharedPtr & msg)
1276 {
1277  RCLCPP_DEBUG(get_logger(), "AmclNode: A new map was received.");
1278  if (!nav2::validateMsg(*msg)) {
1279  RCLCPP_ERROR(get_logger(), "Received map message is malformed. Rejecting.");
1280  return;
1281  }
1282  if (first_map_only_ && first_map_received_) {
1283  return;
1284  }
1285  handleMapMessage(*msg);
1286  first_map_received_ = true;
1287 }
1288 
1289 void
1290 AmclNode::handleMapMessage(const nav_msgs::msg::OccupancyGrid & msg)
1291 {
1292  std::lock_guard<std::recursive_mutex> cfl(mutex_);
1293 
1294  RCLCPP_INFO(
1295  get_logger(), "Received a %d X %d map @ %.3f m/pix",
1296  msg.info.width,
1297  msg.info.height,
1298  msg.info.resolution);
1299  if (msg.header.frame_id != global_frame_id_) {
1300  RCLCPP_WARN(
1301  get_logger(), "Frame_id of map received:'%s' doesn't match global_frame_id:'%s'. This could"
1302  " cause issues with reading published topics",
1303  msg.header.frame_id.c_str(),
1304  global_frame_id_.c_str());
1305  }
1306  freeMapDependentMemory();
1307  map_ = convertMap(msg);
1308 
1309 #if NEW_UNIFORM_SAMPLING
1310  createFreeSpaceVector();
1311 #endif
1312 }
1313 
1314 void
1315 AmclNode::createFreeSpaceVector()
1316 {
1317  int delta = freespace_downsampling_ ? 2 : 1;
1318  // Index of free space
1319  free_space_indices.resize(0);
1320  for (int i = 0; i < map_->size_x; i += delta) {
1321  for (int j = 0; j < map_->size_y; j += delta) {
1322  if (map_->cells[MAP_INDEX(map_, i, j)].occ_state == -1) {
1323  AmclNode::Point2D point = {i, j};
1324  free_space_indices.push_back(point);
1325  }
1326  }
1327  }
1328 }
1329 
1330 void
1331 AmclNode::freeMapDependentMemory()
1332 {
1333  if (map_ != NULL) {
1334  map_free(map_);
1335  map_ = NULL;
1336  }
1337 
1338  // Clear queued laser objects because they hold pointers to the existing
1339  // map, #5202.
1340  lasers_.clear();
1341  lasers_update_.clear();
1342  frame_to_laser_.clear();
1343 }
1344 
1345 // Convert an OccupancyGrid map message into the internal representation. This function
1346 // allocates a map_t and returns it.
1347 map_t *
1348 AmclNode::convertMap(const nav_msgs::msg::OccupancyGrid & map_msg)
1349 {
1350  map_t * map = map_alloc();
1351 
1352  map->size_x = map_msg.info.width;
1353  map->size_y = map_msg.info.height;
1354  map->scale = map_msg.info.resolution;
1355  map->origin_x = map_msg.info.origin.position.x + (map->size_x / 2) * map->scale;
1356  map->origin_y = map_msg.info.origin.position.y + (map->size_y / 2) * map->scale;
1357 
1358  map->cells =
1359  reinterpret_cast<map_cell_t *>(malloc(sizeof(map_cell_t) * map->size_x * map->size_y));
1360 
1361  // Convert to player format
1362  for (int i = 0; i < map->size_x * map->size_y; i++) {
1363  if (map_msg.data[i] == 0) {
1364  map->cells[i].occ_state = -1;
1365  } else if (map_msg.data[i] == 100) {
1366  map->cells[i].occ_state = +1;
1367  } else {
1368  map->cells[i].occ_state = 0;
1369  }
1370  }
1371 
1372  return map;
1373 }
1374 
1375 void
1376 AmclNode::initTransforms()
1377 {
1378  RCLCPP_INFO(get_logger(), "initTransforms");
1379 
1380  // Initialize transform listener and broadcaster
1381  tf_buffer_ = nav2::create_transform_buffer(this, callback_group_);
1382  tf_listener_ = nav2::create_transform_listener(*tf_buffer_, this, true);
1383  tf_broadcaster_ = nav2::create_transform_broadcaster(shared_from_this());
1384 
1385  sent_first_transform_ = false;
1386  latest_tf_valid_ = false;
1387  latest_tf_ = tf2::Transform::getIdentity();
1388 }
1389 
1390 void
1391 AmclNode::initMessageFilters()
1392 {
1393  auto sub_opt = nav2::interfaces::createSubscriptionOptions(
1394  scan_topic_, allow_parameter_qos_overrides_);
1395 
1396  #if RCLCPP_VERSION_GTE(29, 6, 0)
1397  laser_scan_sub_ = std::make_unique<message_filters::Subscriber<sensor_msgs::msg::LaserScan>>(
1398  shared_from_this(), scan_topic_, nav2::qos::SensorDataQoS(), sub_opt);
1399  #else
1400  laser_scan_sub_ = std::make_unique<message_filters::Subscriber<sensor_msgs::msg::LaserScan,
1401  rclcpp_lifecycle::LifecycleNode>>(
1402  std::static_pointer_cast<rclcpp_lifecycle::LifecycleNode>(shared_from_this()),
1403  scan_topic_, nav2::qos::SensorDataQoS().get_rmw_qos_profile(), sub_opt);
1404  #endif
1405 
1406  laser_scan_filter_ = nav2::create_message_filter<sensor_msgs::msg::LaserScan>(
1407  *laser_scan_sub_, *tf_buffer_, odom_frame_id_, 10,
1408  this, transform_tolerance_);
1409 
1410 
1411  laser_scan_connection_ = laser_scan_filter_->registerCallback(
1412  std::bind(&AmclNode::laserReceived, this, std::placeholders::_1));
1413 }
1414 
1415 void
1416 AmclNode::initPubSub()
1417 {
1418  RCLCPP_INFO(get_logger(), "initPubSub");
1419 
1420  particle_cloud_pub_ = create_publisher<nav2_msgs::msg::ParticleCloud>(
1421  "particle_cloud",
1423 
1424  pose_pub_ = create_publisher<geometry_msgs::msg::PoseWithCovarianceStamped>(
1425  "amcl_pose",
1427 
1428  initial_pose_sub_ = create_subscription<geometry_msgs::msg::PoseWithCovarianceStamped>(
1429  "initialpose",
1430  std::bind(&AmclNode::initialPoseReceived, this, std::placeholders::_1));
1431 
1432  map_sub_ = create_subscription<nav_msgs::msg::OccupancyGrid>(
1433  map_topic_,
1434  std::bind(&AmclNode::mapReceived, this, std::placeholders::_1),
1436 
1437  RCLCPP_INFO(get_logger(), "Subscribed to map topic.");
1438 }
1439 
1440 void
1441 AmclNode::initServices()
1442 {
1443  global_loc_srv_ = create_service<std_srvs::srv::Empty>(
1444  "reinitialize_global_localization",
1445  std::bind(
1446  &AmclNode::globalLocalizationCallback, this, std::placeholders::_1,
1447  std::placeholders::_2, std::placeholders::_3));
1448 
1449  initial_guess_srv_ = create_service<nav2_msgs::srv::SetInitialPose>(
1450  "set_initial_pose",
1451  std::bind(
1452  &AmclNode::initialPoseReceivedSrv, this, std::placeholders::_1, std::placeholders::_2,
1453  std::placeholders::_3));
1454 
1455  nomotion_update_srv_ = create_service<std_srvs::srv::Empty>(
1456  "request_nomotion_update",
1457  std::bind(
1458  &AmclNode::nomotionUpdateCallback, this, std::placeholders::_1, std::placeholders::_2,
1459  std::placeholders::_3));
1460 }
1461 
1462 void
1463 AmclNode::initOdometry()
1464 {
1465  // TODO(mjeronimo): We should handle persistence of the last known pose of the robot. We could
1466  // then read that pose here and initialize using that.
1467 
1468  // When pausing and resuming, remember the last robot pose so we don't start at 0:0 again
1469  init_pose_[0] = last_published_pose_.pose.pose.position.x;
1470  init_pose_[1] = last_published_pose_.pose.pose.position.y;
1471  init_pose_[2] = tf2::getYaw(last_published_pose_.pose.pose.orientation);
1472 
1473  if (!initial_pose_is_known_) {
1474  init_cov_[0] = 0.5 * 0.5;
1475  init_cov_[1] = 0.5 * 0.5;
1476  init_cov_[2] = (M_PI / 12.0) * (M_PI / 12.0);
1477  } else {
1478  init_cov_[0] = last_published_pose_.pose.covariance[0];
1479  init_cov_[1] = last_published_pose_.pose.covariance[7];
1480  init_cov_[2] = last_published_pose_.pose.covariance[35];
1481  }
1482 
1483  motion_model_ = plugin_loader_.createSharedInstance(robot_model_type_);
1484  motion_model_->initialize(alpha1_, alpha2_, alpha3_, alpha4_, alpha5_);
1485 
1486  latest_odom_pose_ = geometry_msgs::msg::PoseStamped();
1487 }
1488 
1489 void
1490 AmclNode::initParticleFilter()
1491 {
1492  // Create the particle filter
1493  pf_ = pf_alloc(
1494  min_particles_, max_particles_, alpha_slow_, alpha_fast_,
1495  (pf_init_model_fn_t)AmclNode::uniformPoseGenerator);
1496 
1497  // Seed RNG used by PF resampling and pose generation.
1498  // Keep legacy behavior (time-based) unless user explicitly sets a seed.
1499  if (random_seed_ >= 0) {
1500  // `srand48` expects a platform `long` seed. We avoid using `long` in our code and accept
1501  // truncation when seeding.
1502  srand48(static_cast<int>(random_seed_));
1503  } else {
1504  srand48(static_cast<int>(std::time(nullptr)));
1505  }
1506 
1507  pf_->pop_err = pf_err_;
1508  pf_->pop_z = pf_z_;
1509 
1510  // Initialize the filter
1511  pf_vector_t pf_init_pose_mean = pf_vector_zero();
1512  pf_init_pose_mean.v[0] = init_pose_[0];
1513  pf_init_pose_mean.v[1] = init_pose_[1];
1514  pf_init_pose_mean.v[2] = init_pose_[2];
1515 
1516  pf_matrix_t pf_init_pose_cov = pf_matrix_zero();
1517  pf_init_pose_cov.m[0][0] = init_cov_[0];
1518  pf_init_pose_cov.m[1][1] = init_cov_[1];
1519  pf_init_pose_cov.m[2][2] = init_cov_[2];
1520 
1521  pf_init(pf_, pf_init_pose_mean, pf_init_pose_cov);
1522 
1523  pf_init_ = false;
1524  resample_count_ = 0;
1525  memset(&pf_odom_pose_, 0, sizeof(pf_odom_pose_));
1526 }
1527 
1528 void
1529 AmclNode::initLaserScan()
1530 {
1531  scan_error_count_ = 0;
1532  last_laser_received_ts_ = rclcpp::Time(0);
1533 }
1534 
1535 void
1536 AmclNode::savePoseTimerCallback()
1537 {
1538  if (!active_ || !first_pose_sent_) {
1539  return;
1540  }
1541  savePoseToFile();
1542 }
1543 
1544 void
1545 AmclNode::savePoseToFile()
1546 {
1547  std::string tmp_path = saved_pose_filepath_ + ".tmp";
1548  try {
1549  std::ofstream file(tmp_path);
1550  if (!file.is_open()) {
1551  RCLCPP_WARN(
1552  get_logger(), "Failed to open pose file for writing: %s",
1553  tmp_path.c_str());
1554  return;
1555  }
1556 
1557  auto & pose = last_published_pose_;
1558  double timestamp = pose.header.stamp.sec +
1559  static_cast<double>(pose.header.stamp.nanosec) / 1e9;
1560  file << std::fixed << std::setprecision(9);
1561  file << "timestamp: " << timestamp << "\n";
1562  file << "frame_id: " << pose.header.frame_id << "\n";
1563  file << std::setprecision(6);
1564  file << "x: " << pose.pose.pose.position.x << "\n";
1565  file << "y: " << pose.pose.pose.position.y << "\n";
1566  file << "z: " << pose.pose.pose.position.z << "\n";
1567  file << "yaw: " << tf2::getYaw(pose.pose.pose.orientation) << "\n";
1568  file.close();
1569 
1570  // Atomic rename
1571  if (std::rename(tmp_path.c_str(), saved_pose_filepath_.c_str()) != 0) {
1572  RCLCPP_WARN(
1573  get_logger(), "Failed to rename pose file from %s to %s",
1574  tmp_path.c_str(), saved_pose_filepath_.c_str());
1575  }
1576  } catch (const std::exception & e) {
1577  RCLCPP_WARN(get_logger(), "Failed to save pose to file: %s", e.what());
1578  }
1579 }
1580 
1581 bool
1582 AmclNode::loadPoseFromFile(geometry_msgs::msg::PoseWithCovarianceStamped & pose)
1583 {
1584  std::ifstream file(saved_pose_filepath_);
1585  if (!file.is_open()) {
1586  return false;
1587  }
1588 
1589  try {
1590  std::string line;
1591  double x = 0.0, y = 0.0, z = 0.0, yaw = 0.0;
1592  double timestamp = 0.0;
1593  std::string frame_id;
1594 
1595  while (std::getline(file, line)) {
1596  if (line.empty() || line[0] == '#') {
1597  continue;
1598  }
1599  std::istringstream iss(line);
1600  std::string key;
1601  if (std::getline(iss, key, ':')) {
1602  if (key == "frame_id") {
1603  iss >> std::ws;
1604  std::getline(iss, frame_id);
1605  } else {
1606  double value;
1607  iss >> value;
1608  if (key == "x") {
1609  x = value;
1610  } else if (key == "y") {
1611  y = value;
1612  } else if (key == "z") {
1613  z = value;
1614  } else if (key == "yaw") {
1615  yaw = value;
1616  } else if (key == "timestamp") {
1617  timestamp = value;
1618  }
1619  }
1620  }
1621  }
1622 
1623  pose.header.frame_id = frame_id.empty() ? global_frame_id_ : frame_id;
1624  pose.header.stamp = now(); // Always use current time for relocalization
1625  pose.pose.pose.position.x = x;
1626  pose.pose.pose.position.y = y;
1627  pose.pose.pose.position.z = z;
1628  pose.pose.pose.orientation = orientationAroundZAxis(yaw);
1629 
1630  RCLCPP_INFO(
1631  get_logger(),
1632  "Loaded saved pose from file: x=%.3f, y=%.3f, z=%.3f, yaw=%.3f, "
1633  "originally saved at timestamp=%.3f, frame=%s",
1634  x, y, z, yaw, timestamp, pose.header.frame_id.c_str());
1635 
1636  return true;
1637  } catch (const std::exception & e) {
1638  RCLCPP_WARN(get_logger(), "Failed to parse saved pose file: %s", e.what());
1639  return false;
1640  }
1641 }
1642 
1643 } // namespace nav2_amcl
1644 
1645 #include "rclcpp_components/register_node_macro.hpp"
1646 
1647 // Register the component with class_loader.
1648 // This acts as a sort of entry point, allowing the component to be discoverable when its library
1649 // is being loaded into a running process.
1650 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