visualization.h
Go to the documentation of this file.
1 /*********************************************************************
2  *
3  * Software License Agreement (BSD License)
4  *
5  * Copyright (c) 2016,
6  * TU Dortmund - Institute of Control Theory and Systems Engineering.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  * * Neither the name of the institute nor the names of its
20  * contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  * Author: Christoph Rösmann
37  *********************************************************************/
38 
39 #ifndef VISUALIZATION_H_
40 #define VISUALIZATION_H_
41 
42 
43 
44 // teb stuff
48 
49 // ros stuff
50 #include <ros/publisher.h>
52 
53 // boost
54 #include <boost/graph/adjacency_list.hpp>
55 #include <boost/graph/graph_traits.hpp>
56 
57 // std
58 #include <iterator>
59 
60 // messages
61 #include <nav_msgs/Path.h>
62 #include <geometry_msgs/PoseStamped.h>
63 #include <geometry_msgs/PoseArray.h>
64 #include <std_msgs/ColorRGBA.h>
65 #include <tf/transform_datatypes.h>
66 #include <nav_msgs/Odometry.h>
67 #include <nav_msgs/Path.h>
68 #include <visualization_msgs/Marker.h>
69 
70 namespace teb_local_planner
71 {
72 
73 class TebOptimalPlanner;
74 
75 
80 class TebVisualization
81 {
82 public:
83 
89 
95  TebVisualization(ros::NodeHandle& nh, const TebConfig& cfg);
96 
104  void initialize(ros::NodeHandle& nh, const TebConfig& cfg);
105 
106 
109 
114  void publishGlobalPlan(const std::vector<geometry_msgs::PoseStamped>& global_plan) const;
115 
120  void publishLocalPlan(const std::vector<geometry_msgs::PoseStamped>& local_plan) const;
121 
129  void publishLocalPlanAndPoses(const TimedElasticBand& teb) const;
130 
139  void publishRobotFootprintModel(const PoseSE2& current_pose, const BaseRobotFootprintModel& robot_model, const std::string& ns = "RobotFootprintModel",
140  const std_msgs::ColorRGBA& color = toColorMsg(0.5, 0.0, 0.8, 0.0));
141 
142  void publishRobotFootprint(const PoseSE2& current_pose, const std::vector<geometry_msgs::Point>& footprint,
143  const std::string& ns, const std_msgs::ColorRGBA &color);
144 
152  void publishInfeasibleRobotPose(const PoseSE2& infeasible_pose, const BaseRobotFootprintModel& robot_model,
153  const std::vector<geometry_msgs::Point>& footprint);
154 
161  void publishObstacles(const ObstContainer& obstacles, double scale = 0.1) const;
162 
167  void publishViaPoints(const std::vector< Eigen::Vector2d, Eigen::aligned_allocator<Eigen::Vector2d> >& via_points, const std::string& ns = "ViaPoints") const;
168 
177  template <typename GraphType>
178  void publishGraph(const GraphType& graph, const std::string& ns_prefix = "Graph");
179 
205  template <typename BidirIter>
206  void publishPathContainer(BidirIter first, BidirIter last, const std::string& ns = "PathContainer");
207 
214  void publishTebContainer(const std::vector< boost::shared_ptr<TebOptimalPlanner> >& teb_planner, const std::string& ns = "TebContainer");
215 
226  void publishFeedbackMessage(const std::vector< boost::shared_ptr<TebOptimalPlanner> >& teb_planners, unsigned int selected_trajectory_idx, const ObstContainer& obstacles);
227 
237  void publishFeedbackMessage(const TebOptimalPlanner& teb_planner, const ObstContainer& obstacles);
238 
240 
249  static std_msgs::ColorRGBA toColorMsg(double a, double r, double g, double b);
250 
251 protected:
252 
257  bool printErrorWhenNotInitialized() const;
258 
264 
265  const TebConfig* cfg_;
266 
267  bool initialized_;
268 
269 
270 public:
271  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
272 };
273 
276 
279 
280 
281 } // namespace teb_local_planner
282 
283 
284 // Include template method implementations / definitions
286 
287 #endif /* VISUALIZATION_H_ */
ros::Publisher
boost::shared_ptr< TebOptimalPlanner >
teb_local_planner::TebVisualization::publishGraph
void publishGraph(const GraphType &graph, const std::string &ns_prefix="Graph")
Publish a boost::adjacency_list (boost's graph datatype) via markers.
Definition: visualization.hpp:84
via_points
ViaPointContainer via_points
Definition: test_optim_node.cpp:55
visualization.hpp
teb_local_planner::TebVisualization::publishTebContainer
void publishTebContainer(const std::vector< boost::shared_ptr< TebOptimalPlanner > > &teb_planner, const std::string &ns="TebContainer")
Publish multiple Tebs from a container class (publish as marker message).
Definition: visualization.cpp:429
teb_local_planner::TebVisualization::publishGlobalPlan
void publishGlobalPlan(const std::vector< geometry_msgs::PoseStamped > &global_plan) const
Publish a given global plan to the ros topic ../../global_plan.
Definition: visualization.cpp:111
goal_functions.h
teb_local_planner::TebVisualization::teb_marker_pub_
ros::Publisher teb_marker_pub_
Publisher for visualization markers.
Definition: visualization.h:298
teb_local_planner::TebVisualization::publishInfeasibleRobotPose
void publishInfeasibleRobotPose(const PoseSE2 &infeasible_pose, const BaseRobotFootprintModel &robot_model, const std::vector< geometry_msgs::Point > &footprint)
Publish the robot footprint model and the actual robot footprint at an infeasible pose.
Definition: visualization.cpp:204
teb_local_planner::TebVisualization::feedback_pub_
ros::Publisher feedback_pub_
Publisher for the feedback message for analysis and debug purposes.
Definition: visualization.h:299
teb_local_planner::TebVisualization::printErrorWhenNotInitialized
bool printErrorWhenNotInitialized() const
Small helper function that checks if initialize() has been called and prints an error message if not.
Definition: visualization.cpp:566
teb_local_planner::TebVisualization::toColorMsg
static std_msgs::ColorRGBA toColorMsg(double a, double r, double g, double b)
Helper function to generate a color message from single values.
Definition: visualization.cpp:556
publisher.h
teb_local_planner::TebVisualizationConstPtr
boost::shared_ptr< const TebVisualization > TebVisualizationConstPtr
Abbrev. for shared instances of the TebVisualization (read-only)
Definition: visualization.h:314
teb_local_planner::TebVisualization::publishFeedbackMessage
void publishFeedbackMessage(const std::vector< boost::shared_ptr< TebOptimalPlanner > > &teb_planners, unsigned int selected_trajectory_idx, const ObstContainer &obstacles)
Publish a feedback message (multiple trajectory version)
Definition: visualization.cpp:480
teb_local_planner::TebVisualization::initialize
void initialize(ros::NodeHandle &nh, const TebConfig &cfg)
Initializes the class and registers topics.
Definition: visualization.cpp:91
teb_config.h
timed_elastic_band.h
teb_local_planner::ObstContainer
std::vector< ObstaclePtr > ObstContainer
Abbrev. for containers storing multiple obstacles.
Definition: obstacles.h:333
robot_footprint_model.h
teb_local_planner::TebVisualization::publishObstacles
void publishObstacles(const ObstContainer &obstacles, double scale=0.1) const
Publish obstacle positions to the ros topic ../../teb_markers.
Definition: visualization.cpp:212
teb_local_planner::TebVisualization::local_plan_pub_
ros::Publisher local_plan_pub_
Publisher for the local plan.
Definition: visualization.h:296
teb_local_planner::TebVisualization::TebVisualization
TebVisualization()
Default constructor.
Definition: visualization.cpp:82
teb_local_planner::TebVisualizationPtr
boost::shared_ptr< TebVisualization > TebVisualizationPtr
Abbrev. for shared instances of the TebVisualization.
Definition: visualization.h:311
teb_local_planner::TebVisualization::teb_poses_pub_
ros::Publisher teb_poses_pub_
Publisher for the trajectory pose sequence.
Definition: visualization.h:297
transform_datatypes.h
teb_local_planner::TebVisualization::global_plan_pub_
ros::Publisher global_plan_pub_
Publisher for the global plan.
Definition: visualization.h:295
teb_local_planner::TebVisualization::publishPathContainer
void publishPathContainer(BidirIter first, BidirIter last, const std::string &ns="PathContainer")
Publish multiple 2D paths (each path given as a point sequence) from a container class.
Definition: visualization.hpp:215
teb_local_planner::TebVisualization::publishRobotFootprintModel
void publishRobotFootprintModel(const PoseSE2 &current_pose, const BaseRobotFootprintModel &robot_model, const std::string &ns="RobotFootprintModel", const std_msgs::ColorRGBA &color=toColorMsg(0.5, 0.0, 0.8, 0.0))
Publish the visualization of the robot model.
Definition: visualization.cpp:158
teb_local_planner::TebVisualization::publishViaPoints
void publishViaPoints(const std::vector< Eigen::Vector2d, Eigen::aligned_allocator< Eigen::Vector2d > > &via_points, const std::string &ns="ViaPoints") const
Publish via-points to the ros topic ../../teb_markers.
Definition: visualization.cpp:396
teb_local_planner::TebVisualization::publishLocalPlanAndPoses
void publishLocalPlanAndPoses(const TimedElasticBand &teb) const
Publish Timed_Elastic_Band related stuff (local plan, pose sequence).
Definition: visualization.cpp:124
teb_local_planner::TebVisualization::publishRobotFootprint
void publishRobotFootprint(const PoseSE2 &current_pose, const std::vector< geometry_msgs::Point > &footprint, const std::string &ns, const std_msgs::ColorRGBA &color)
Definition: visualization.cpp:183
teb_local_planner::TebVisualization::initialized_
bool initialized_
Keeps track about the correct initialization of this class.
Definition: visualization.h:303
teb_local_planner::TebVisualization::publishLocalPlan
void publishLocalPlan(const std::vector< geometry_msgs::PoseStamped > &local_plan) const
Publish a given local plan to the ros topic ../../local_plan.
Definition: visualization.cpp:117
teb_local_planner::TebVisualization::cfg_
const TebConfig * cfg_
Config class that stores and manages all related parameters.
Definition: visualization.h:301
teb_local_planner
Definition: distance_calculations.h:46
ros::NodeHandle


teb_local_planner
Author(s): Christoph Rösmann
autogenerated on Sun Jan 7 2024 03:45:15