Nav2 Navigation Stack - lyrical  lyrical
ROS 2 Navigation Stack
prefer_forward.cpp
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2017, Locus Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "dwb_critics/prefer_forward.hpp"
36 #include <math.h>
37 #include "pluginlib/class_list_macros.hpp"
38 
40 
41 namespace dwb_critics
42 {
43 
44 void PreferForwardCritic::onInit()
45 {
46  auto node = node_.lock();
47  if (!node) {
48  throw std::runtime_error{"Failed to lock node"};
49  }
50 
51  penalty_ = node->declare_or_get_parameter(
52  dwb_plugin_name_ + "." + name_ + ".penalty", 1.0);
53  strafe_x_ = node->declare_or_get_parameter(
54  dwb_plugin_name_ + "." + name_ + ".strafe_x", 0.1);
55  strafe_theta_ = node->declare_or_get_parameter(
56  dwb_plugin_name_ + "." + name_ + ".strafe_theta", 0.2);
57  theta_scale_ = node->declare_or_get_parameter(
58  dwb_plugin_name_ + "." + name_ + ".theta_scale", 10.0);
59 }
60 
61 double PreferForwardCritic::scoreTrajectory(const dwb_msgs::msg::Trajectory2D & traj)
62 {
63  // backward motions bad on a robot without backward sensors
64  if (traj.velocity.x < 0.0) {
65  return penalty_;
66  }
67  // strafing motions also bad on such a robot
68  if (traj.velocity.x < strafe_x_ && fabs(traj.velocity.theta) < strafe_theta_) {
69  return penalty_;
70  }
71 
72  // the more we rotate, the less we progress forward
73  return fabs(traj.velocity.theta) * theta_scale_;
74 }
75 
76 } // namespace dwb_critics
Evaluates a Trajectory2D to produce a score.
Penalize trajectories with move backwards and/or turn too much.
double scoreTrajectory(const dwb_msgs::msg::Trajectory2D &traj) override
Return a raw score for the given trajectory.