Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
opennav_docking::PoseFilter Class Reference

Filter for a sequence of pose measurements. More...

#include <nav2_docking/opennav_docking/include/opennav_docking/pose_filter.hpp>

Collaboration diagram for opennav_docking::PoseFilter:
Collaboration graph
[legend]

Public Member Functions

 PoseFilter (double coef, double timeout)
 Create a pose filter instance. More...
 
geometry_msgs::msg::PoseStamped update (const geometry_msgs::msg::PoseStamped &measurement)
 Update the filter. More...
 

Protected Member Functions

void filter (double &filt, double meas)
 

Protected Attributes

double coef_
 
double timeout_
 
geometry_msgs::msg::PoseStamped pose_
 

Detailed Description

Filter for a sequence of pose measurements.

Definition at line 27 of file pose_filter.hpp.

Constructor & Destructor Documentation

◆ PoseFilter()

opennav_docking::PoseFilter::PoseFilter ( double  coef,
double  timeout 
)

Create a pose filter instance.

Parameters
coefFiltering coefficient. Valid range is 0-1, where 0 means take the new measurement
timeoutIf time between measurements exceeds this value, take the new measurement.

Definition at line 22 of file pose_filter.cpp.

Member Function Documentation

◆ update()

geometry_msgs::msg::PoseStamped opennav_docking::PoseFilter::update ( const geometry_msgs::msg::PoseStamped &  measurement)

Update the filter.

Parameters
measurementThe new pose measurement.
Returns
Filtered measurement

Definition at line 30 of file pose_filter.cpp.


The documentation for this class was generated from the following files: