ImagePerception.hpp

Go to the documentation of this file.

// Copyright 2025 Intelligent Robotics Lab
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef EASYNAV_SENSORS__TYPES__IMAGEPERCEPTION_HPP_
#define EASYNAV_SENSORS__TYPES__IMAGEPERCEPTION_HPP_
 
#include <mutex>
#include <string>
#include <utility>
#include <vector>
#include <memory>
 
#if __has_include("cv_bridge/cv_bridge.hpp")
#include "cv_bridge/cv_bridge.hpp"
#else
#include "cv_bridge/cv_bridge.h"  // Humble: no .hpp header yet
#endif
 
#include "rclcpp_lifecycle/lifecycle_node.hpp"
 
#include "easynav_sensors/types/Perceptions.hpp"
 
namespace easynav
{

class ImagePerception : public PerceptionBase
{
public:
  static constexpr std::string_view default_group_ = "image";

  static inline bool supports_msg_type(std::string_view t)
  {
    return t == "sensor_msgs/msg/Image";
  }
 
  ImagePerception()
  {
    [[maybe_unused]] static const bool _ = [] {
        ::easynav::NavState::register_printer<ImagePerception>(
          [](const ImagePerception & perception) {
            std::ostringstream ret;
            ret << "{ " << perception.stamp.seconds()
                << " } ImagePerception ("
                << perception.data.cols << " x " << perception.data.rows
                << ") in frame [" << perception.frame_id
                << "] with ts " << perception.stamp.seconds() << "\n";
            return ret.str();
          });
        return true;
      }();
  }
 
  ImagePerception(const ImagePerception & other)
  {
    std::lock_guard<std::mutex> lock(other.mutex_);
    stamp = other.stamp;
    frame_id = other.frame_id;
    valid = other.valid;
    new_data = other.new_data;
    data = other.data;
  }
 
  ImagePerception & operator=(const ImagePerception & other)
  {
    if (this == &other) {
      return *this;
    }
 
    std::scoped_lock lock(mutex_, other.mutex_);
    stamp = other.stamp;
    frame_id = other.frame_id;
    valid = other.valid;
    new_data = other.new_data;
    data = other.data;
 
    return *this;
  }

  cv::Mat data;

  void set_data(
    cv::Mat && image, const rclcpp::Time & msg_stamp,
    const std::string & msg_frame_id)
  {
    std::lock_guard<std::mutex> lock(mutex_);
    stamp = msg_stamp;
    frame_id = msg_frame_id;
    new_data = true;
    data = std::move(image);
    valid = true;
  }

  void mark_invalid(const rclcpp::Time & msg_stamp, const std::string & msg_frame_id)
  {
    std::lock_guard<std::mutex> lock(mutex_);
    stamp = msg_stamp;
    frame_id = msg_frame_id;
    new_data = true;
    valid = false;
  }

  bool consume_new_data()
  {
    std::lock_guard<std::mutex> lock(mutex_);
    const bool had_new_data = new_data;
    new_data = false;
    return had_new_data;
  }
 
protected:
  mutable std::mutex mutex_;
};

class ImagePerceptionHandler : public PerceptionHandler
{
public:
  void on_initialize() override;

  bool cycle_rt([[maybe_unused]] std::shared_ptr<NavState> nav_state) override;

  std::shared_ptr<PerceptionBase> get_perception() const override {return perception_data_;}
 
private:
  std::shared_ptr<ImagePerception> perception_data_ {nullptr};

  rclcpp::SubscriptionBase::SharedPtr perception_sub_;
};

using ImagePerceptions =
  std::vector<std::shared_ptr<ImagePerception>>;

rclcpp::Time get_latest_image_perceptions_stamp(const ImagePerceptions & perceptions);
 
}  // namespace easynav
 
#endif  // EASYNAV_SENSORS__TYPES__IMAGEPERCEPTION_HPP_