Skip to content

Commit

Permalink
Fix docstring spacing in newly added trajectory Python bindings (#2471)
Browse files Browse the repository at this point in the history
(cherry picked from commit 19c58b8)

# Conflicts:
#	moveit_py/src/moveit/moveit_core/robot_trajectory/robot_trajectory.cpp
  • Loading branch information
sea-bass authored and mergify[bot] committed Oct 24, 2023
1 parent 7085b0d commit 8ade505
Showing 1 changed file with 33 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,43 @@ void init_robot_trajectory(py::module& m)
Returns:
list of float: The duration from previous of each waypoint in the trajectory.
)")
<<<<<<< HEAD
=======
.def("apply_totg_time_parameterization", &trajectory_processing::applyTOTGTimeParameterization,
py::arg("velocity_scaling_factor"), py::arg("acceleration_scaling_factor"), py::kw_only(),
py::arg("path_tolerance") = 0.1, py::arg("resample_dt") = 0.1, py::arg("min_angle_change") = 0.001,
R"(
Adds time parameterization to the trajectory using the Time-Optimal Trajectory Generation (TOTG) algorithm.
Args:
velocity_scaling_factor (float): The velocity scaling factor.
acceleration_scaling_factor (float): The acceleration scaling factor.
path_tolerance (float): The path tolerance to use for time parameterization (default: 0.1).
resample_dt (float): The time step to use for time parameterization (default: 0.1).
min_angle_change (float): The minimum angle change to use for time parameterization (default: 0.001).
)
Returns:
bool: True if the trajectory was successfully retimed, false otherwise.
)")
.def("apply_ruckig_smoothing", &trajectory_processing::applyRuckigSmoothing, py::arg("velocity_scaling_factor"),
py::arg("acceleration_scaling_factor"), py::kw_only(), py::arg("mitigate_overshoot") = false,
py::arg("overshoot_threshold") = 0.01,
R"(
Applies Ruckig smoothing to the trajectory.
Args:
velocity_scaling_factor (float): The velocity scaling factor.
acceleration_scaling_factor (float): The acceleration scaling factor.
mitigate_overshoot (bool): Whether to mitigate overshoot during smoothing (default: false).
overshoot_threshold (float): The maximum allowed overshoot during smoothing (default: 0.01
)
Returns:
bool: True if the trajectory was successfully retimed, false otherwise.
)")
>>>>>>> 19c58b83c (Fix docstring spacing in newly added trajectory Python bindings (#2471))
.def("get_robot_trajectory_msg", &moveit_py::bind_robot_trajectory::get_robot_trajectory_msg,
py::arg("joint_filter") = std::vector<std::string>(),
R"(
Get the trajectory as a moveit_msgs.msg.RobotTrajectory message.
Returns:
Returns:
moveit_msgs.msg.RobotTrajectory: A ROS robot trajectory message.
)")
.def("set_robot_trajectory_msg", &moveit_py::bind_robot_trajectory::set_robot_trajectory_msg,
Expand Down

0 comments on commit 8ade505

Please sign in to comment.