Skip to content

Commit abeb3ec

Browse files
author
Stanislav Byriukov
committed
docs(amcl): document random_seed parameter
1 parent d6d5350 commit abeb3ec

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

configuration/packages/configuring-amcl.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,20 @@ Parameters
276276
Description
277277
Particle filter population density. 2.33 is the 99% percentile.
278278

279+
:random_seed:
280+
281+
============== =============================
282+
Type Default
283+
-------------- -----------------------------
284+
int -1
285+
============== =============================
286+
287+
Description
288+
Seed for the particle filter RNG.
289+
290+
- ``random_seed >= 0``: seed the RNG with the provided value (repeatable runs).
291+
- ``random_seed < 0`` (default): seed the RNG from time (preserves historical behavior).
292+
279293
:recovery_alpha_fast:
280294

281295
============== =============================
@@ -540,6 +554,7 @@ Example
540554
odom_frame_id: "odom"
541555
pf_err: 0.05
542556
pf_z: 0.99
557+
random_seed: -1
543558
recovery_alpha_fast: 0.0
544559
recovery_alpha_slow: 0.0
545560
resample_interval: 1

0 commit comments

Comments
 (0)