Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions configuration/packages/configuring-savitzky-golay-smoother.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,28 @@ This algorithm is deterministic and low-parameter. In the below image, some odd
Savitzky-Golay Smoother Parameters
**********************************

:window_size:

============== ===========================
Type Default
-------------- ---------------------------
int 7
============== ===========================

Description
Size of the smoothing window. Must be an odd integer, with a minimum value of 3

:poly_order:

============== ===========================
Type Default
-------------- ---------------------------
int 3
============== ===========================

Description
Order of the polynomial used to fit the samples in each smoothing window

:do_refinement:

============== ===========================
Expand Down Expand Up @@ -65,6 +87,8 @@ Example
smoother_plugins: ["savitzky_golay_smoother"]
savitzky_golay_smoother:
plugin: "nav2_smoother::SavitzkyGolaySmoother"
window_size: 7
poly_order: 3
do_refinement: True
refinement_num: 2
enforce_path_inversion: True
11 changes: 11 additions & 0 deletions migration/Kilted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -347,3 +347,14 @@ Example:
polygon_frame_blackboard_id: "polygon_frame_id"

See also :ref:`configuring_bt_navigator`

Option to have custom window size and poly order in Savitsky-Golay Smoother
---------------------------------------------------------------------------

In `PR #5489 <https://github.com/ros-navigation/navigation2/pull/5489>`_, option to have custom window size and polynomial order was added.
Previously, the implementation used a fixed window size of 7 and a polynomial order of 3.

Default value:

- window_size: 7
- poly_order: 3