Adds a test for tf message filters with pcl pointclouds

pcl_ros/CMakeLists.txt

@@ -168,6 +168,20 @@ target_link_libraries(convert_pcd_to_image pcl_io pcl_common ${Boost_LIBRARIES}
 add_executable(convert_pointcloud_to_image tools/convert_pointcloud_to_image.cpp)
 target_link_libraries(convert_pointcloud_to_image pcl_io ${Boost_LIBRARIES} ${catkin_LIBRARIES} ${Eigen_LIBRARIES} ${PCL_LIBRARIES})
 
+#############
+## Testing ##
+#############
+
+if(CATKIN_ENABLE_TESTING)
+  # we don't have to find_package GTEST; catkin does it for us
+  include_directories(${GTEST_INCLUDE_DIRS})
+  add_executable(test_tf_message_filter_pcl EXCLUDE_FROM_ALL src/test/test_tf_message_filter_pcl.cpp)
+  target_link_libraries(test_tf_message_filter_pcl ${catkin_LIBRARIES} ${GTEST_LIBRARIES})
+  add_dependencies(tests test_tf_message_filter_pcl)
+  find_package(rostest)
+  add_rostest(tests/test_tf_message_filter_pcl.xml)
+endif(CATKIN_ENABLE_TESTING)
+
 
 install(DIRECTORY include/${PROJECT_NAME}/
   DESTINATION ${CATKIN_PACKAGE_INCLUDE_DESTINATION})

pcl_ros/package.xml

@@ -58,6 +58,8 @@
   <run_depend>tf</run_depend>
   <run_depend>python-vtk</run_depend>
   <run_depend>libvtk-java</run_depend>
+  
+  <test_depend>rostest</test_depend>
 
   <export>
      <nodelet plugin="${prefix}/pcl_nodelets.xml"/>

pcl_ros/src/test/test_tf_message_filter_pcl.cpp

@@ -0,0 +1,390 @@
+/*
+ * Copyright (c) 2008, Willow Garage, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the Willow Garage, Inc. nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/** \author Josh Faust */
+
+#include <pcl/point_types.h>
+#include <pcl/point_cloud.h>
+
+#include <tf/message_filter.h>
+#include <tf/transform_listener.h>
+#include <tf/transform_broadcaster.h>
+
+#include <boost/bind.hpp>
+#include <boost/scoped_ptr.hpp>
+
+#include <pcl_ros/point_cloud.h>
+#include <pcl_conversions/pcl_conversions.h>
+
+#include <ros/ros.h>
+
+#include <gtest/gtest.h>
+
+using namespace tf;
+
+// using a random point type, as we want to make sure that it does work with
+// other points than just XYZ
+typedef pcl::PointCloud<pcl::PointXYZRGBNormal> PCDType;
+
+
+/// Sets pcl_stamp from stamp, BUT alters stamp
+/// a little to round it to millisecond. This is because converting back
+/// and forth from pcd to ros time induces some rounding errors.
+void setStamp(ros::Time &stamp, pcl::uint64_t &pcl_stamp)
+{
+  // round to millisecond
+  static const uint32_t mult = 1e6;
+  stamp.nsec /= mult;
+  stamp.nsec *= mult;
+
+  pcl_conversions::toPCL(stamp, pcl_stamp);
+
+  // verify
+  {
+    ros::Time t;
+    pcl_conversions::fromPCL(pcl_stamp, t);
+    ROS_ASSERT_MSG(t==stamp, "%d/%d vs %d/%d", t.sec, t.nsec, stamp.sec, stamp.nsec);
+  }
+}
+
+class Notification
+{
+public:
+  Notification(int expected_count)
+  : count_(0)
+  , expected_count_(expected_count)
+  , failure_count_(0)
+  {
+  }
+
+  void notify(const PCDType::ConstPtr& message)
+  {
+    ++count_;
+  }
+
+  void failure(const PCDType::ConstPtr& message, FilterFailureReason reason)
+  {
+    ++failure_count_;
+  }
+
+  int count_;
+  int expected_count_;
+  int failure_count_;
+};
+
+TEST(MessageFilter, noTransforms)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+
+  PCDType::Ptr msg(new PCDType);
+  ros::Time stamp = ros::Time::now();
+  setStamp(stamp, msg->header.stamp);
+  msg->header.frame_id = "frame2";
+  filter.add(msg);
+
+  EXPECT_EQ(0, n.count_);
+}
+
+TEST(MessageFilter, noTransformsSameFrame)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+
+  PCDType::Ptr msg(new PCDType);
+  ros::Time stamp = ros::Time::now();
+  setStamp(stamp, msg->header.stamp);
+  msg->header.frame_id = "frame1";
+  filter.add(msg);
+
+  EXPECT_EQ(1, n.count_);
+}
+
+TEST(MessageFilter, preexistingTransforms)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+
+  PCDType::Ptr msg(new PCDType);
+
+  ros::Time stamp = ros::Time::now();
+  setStamp(stamp, msg->header.stamp);
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame2");
+  tf_client.setTransform(transform);
+
+  msg->header.frame_id = "frame2";
+  filter.add(msg);
+
+  EXPECT_EQ(1, n.count_);
+}
+
+TEST(MessageFilter, postTransforms)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+
+  ros::Time stamp = ros::Time::now();
+  PCDType::Ptr msg(new PCDType);
+  setStamp(stamp, msg->header.stamp);
+  msg->header.frame_id = "frame2";
+
+  filter.add(msg);
+
+  EXPECT_EQ(0, n.count_);
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame2");
+  tf_client.setTransform(transform);
+
+  ros::WallDuration(0.1).sleep();
+  ros::spinOnce();
+
+  EXPECT_EQ(1, n.count_);
+}
+
+TEST(MessageFilter, queueSize)
+{
+  tf::TransformListener tf_client;
+  Notification n(10);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 10);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+  filter.registerFailureCallback(boost::bind(&Notification::failure, &n, _1, _2));
+
+  ros::Time stamp = ros::Time::now();
+  pcl::uint64_t pcl_stamp;
+  setStamp(stamp, pcl_stamp);
+
+  for (int i = 0; i < 20; ++i)
+  {
+    PCDType::Ptr msg(new PCDType);
+    msg->header.stamp = pcl_stamp;
+    msg->header.frame_id = "frame2";
+
+    filter.add(msg);
+  }
+
+  EXPECT_EQ(0, n.count_);
+  EXPECT_EQ(10, n.failure_count_);
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame2");
+  tf_client.setTransform(transform);
+
+  ros::WallDuration(0.1).sleep();
+  ros::spinOnce();
+
+  EXPECT_EQ(10, n.count_);
+}
+
+TEST(MessageFilter, setTargetFrame)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+  filter.setTargetFrame("frame1000");
+
+  ros::Time stamp = ros::Time::now();
+  PCDType::Ptr msg(new PCDType);
+  setStamp(stamp, msg->header.stamp);
+  msg->header.frame_id = "frame2";
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1000", "frame2");
+  tf_client.setTransform(transform);
+
+  filter.add(msg);
+
+
+  EXPECT_EQ(1, n.count_);
+}
+
+TEST(MessageFilter, multipleTargetFrames)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+
+  std::vector<std::string> target_frames;
+  target_frames.push_back("frame1");
+  target_frames.push_back("frame2");
+  filter.setTargetFrames(target_frames);
+
+  ros::Time stamp = ros::Time::now();
+  PCDType::Ptr msg(new PCDType);
+  setStamp(stamp, msg->header.stamp);
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame3");
+  tf_client.setTransform(transform);
+
+  msg->header.frame_id = "frame3";
+  filter.add(msg);
+
+  ros::WallDuration(0.1).sleep();
+  ros::spinOnce();
+
+  EXPECT_EQ(0, n.count_); // frame1->frame3 exists, frame2->frame3 does not (yet)
+
+  //ros::Time::setNow(ros::Time::now() + ros::Duration(1.0));
+
+  transform.child_frame_id_ = "frame2";
+  tf_client.setTransform(transform);
+
+  ros::WallDuration(0.1).sleep();
+  ros::spinOnce();
+
+  EXPECT_EQ(1, n.count_);  // frame2->frame3 now exists
+}
+
+TEST(MessageFilter, tolerance)
+{
+  ros::Duration offset(0.2);
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerCallback(boost::bind(&Notification::notify, &n, _1));
+  filter.setTolerance(offset);
+
+  ros::Time stamp = ros::Time::now();
+  pcl::uint64_t pcl_stamp;
+  setStamp(stamp, pcl_stamp);
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame2");
+  tf_client.setTransform(transform);
+
+  PCDType::Ptr msg(new PCDType);
+  msg->header.frame_id = "frame2";
+  msg->header.stamp = pcl_stamp;
+  filter.add(msg);
+
+  EXPECT_EQ(0, n.count_); //No return due to lack of space for offset
+
+  //ros::Time::setNow(ros::Time::now() + ros::Duration(0.1));
+
+  transform.stamp_ += offset*1.1;
+  tf_client.setTransform(transform);
+
+  ros::WallDuration(0.1).sleep();
+  ros::spinOnce();
+
+  EXPECT_EQ(1, n.count_); // Now have data for the message published earlier
+
+  stamp += offset;
+  setStamp(stamp, pcl_stamp);
+  msg->header.stamp = pcl_stamp;
+
+  filter.add(msg);
+
+  EXPECT_EQ(1, n.count_); // Latest message is off the end of the offset
+}
+
+TEST(MessageFilter, outTheBackFailure)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerFailureCallback(boost::bind(&Notification::failure, &n, _1, _2));
+
+  ros::Time stamp = ros::Time::now();
+  PCDType::Ptr msg(new PCDType);
+  setStamp(stamp, msg->header.stamp);
+
+  tf::StampedTransform transform(tf::Transform(tf::Quaternion(0,0,0,1), tf::Vector3(1,2,3)), stamp, "frame1", "frame2");
+  tf_client.setTransform(transform);
+
+  transform.stamp_ = stamp + ros::Duration(10000);
+  tf_client.setTransform(transform);
+
+  msg->header.frame_id = "frame2";
+  filter.add(msg);
+
+  EXPECT_EQ(1, n.failure_count_);
+}
+
+TEST(MessageFilter, emptyFrameIDFailure)
+{
+  tf::TransformListener tf_client;
+  Notification n(1);
+  MessageFilter<PCDType> filter(tf_client, "frame1", 1);
+  filter.registerFailureCallback(boost::bind(&Notification::failure, &n, _1, _2));
+
+  PCDType::Ptr msg(new PCDType);
+  msg->header.frame_id = "";
+  filter.add(msg);
+
+  EXPECT_EQ(1, n.failure_count_);
+}
+
+TEST(MessageFilter, removeCallback)
+{
+  // Callback queue in separate thread
+  ros::CallbackQueue cbqueue;
+  ros::AsyncSpinner spinner(1, &cbqueue);
+  ros::NodeHandle threaded_nh;
+  threaded_nh.setCallbackQueue(&cbqueue);
+
+  // TF filters; no data needs to be published
+  boost::scoped_ptr<tf::TransformListener> tf_listener;
+  boost::scoped_ptr<tf::MessageFilter<PCDType> > tf_filter;
+
+  spinner.start();
+  for (int i = 0; i < 3; ++i) {
+    tf_listener.reset(new tf::TransformListener());
+    // Have callback fire at high rate to increase chances of race condition
+    tf_filter.reset(
+      new tf::MessageFilter<PCDType>(*tf_listener,
+                                                         "map", 5, threaded_nh,
+                                                         ros::Duration(0.000001)));
+
+    // Sleep and reset; sleeping increases chances of race condition
+    ros::Duration(0.001).sleep();
+    tf_filter.reset();
+    tf_listener.reset();
+  }
+  spinner.stop();
+}
+
+int main(int argc, char** argv)
+{
+  testing::InitGoogleTest(&argc, argv);
+
+  ros::Time::setNow(ros::Time());
+  ros::init(argc, argv, "test_message_filter");
+  ros::NodeHandle nh;
+
+  int ret = RUN_ALL_TESTS();
+
+  return ret;
+}

pcl_ros/tests/test_tf_message_filter_pcl.xml

@@ -0,0 +1,3 @@
+<launch>
+  <test test-name="test_tf_message_filter_pcl" pkg="pcl_ros" type="test_tf_message_filter_pcl"/>
+</launch>