Skip to content

Commit 5787085

Browse files
authored
Merge pull request #2457 from borglab/codex/audit-published-doc-links
Fix published notebook/doc links to website routes
2 parents 00e0d73 + 165143c commit 5787085

File tree

7 files changed

+16
-17
lines changed

7 files changed

+16
-17
lines changed

gtsam/geometry/doc/Pose2.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@
787787
},
788788
"source": [
789789
"## Example: SLAM\n",
790-
"`Pose2` can be used as the basis to perform simultaneous localization and mapping (SLAM), as seen in the example [here](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/Pose2SLAMExample.ipynb).\n"
790+
"`Pose2` can be used as the basis to perform simultaneous localization and mapping (SLAM), as seen in the example [here](https://borglab.github.io/gtsam/pose2slamexample/).\n"
791791
]
792792
}
793793
],
@@ -805,4 +805,4 @@
805805
},
806806
"nbformat": 4,
807807
"nbformat_minor": 0
808-
}
808+
}

gtsam/navigation/doc/EKF-variants.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,12 @@ The `LeftLinearEKF` class implements a `predict` method that takes `W`, a functo
173173

174174
## NavStateImuEKF: NavState + IMU EKF
175175

176-
The **[NavStateImuEKF](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/doc/NavStateImuEKF.ipynb)** is a left-invariant EKF specialized to GTSAM’s NavState $X=(R,p,v)$ that uses IMU measurements to form a NavState increment and composes it onto the current state.
176+
The **[NavStateImuEKF](https://borglab.github.io/gtsam/navstateimuekf/)** is a left-invariant EKF specialized to GTSAM’s NavState $X=(R,p,v)$ that uses IMU measurements to form a NavState increment and composes it onto the current state.
177177

178178
- Predict: `ekf.predict(omega_b, f_b, dt)` uses continuous-time process noise Q scaled by `dt` and composes the IMU-driven increment. Increments for position and velocity are expressed in the body frame, consistent with GTSAM.
179179
- Update: Use the standard EKF update with a measurement model `h(X)` or the vector bridge `updateWithVector(prediction, H, z, R)`. For a world-position measurement, the Jacobian in the EKF local coordinates `[δθ, δp_body, δv_body]` is `H = [0, R, 0]`.
180180

181-
More: **[Full tutorial (with plots)](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/NavStateImuExample.ipynb)**, Source: [NavStateImuEKF.h](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/NavStateImuEKF.h), [NavStateImuEKF.cpp](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/NavStateImuEKF.cpp)
181+
More: **[Full tutorial (with plots)](https://borglab.github.io/gtsam/navstateimuexample/)**, Source: [NavStateImuEKF.h](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/NavStateImuEKF.h), [NavStateImuEKF.cpp](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/NavStateImuEKF.cpp)
182182

183183
## EquivariantFilter
184184
The **[EquivariantFilter](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/EquivariantFilter.h)** class implements the Equivariant Filter (EqF) for state estimation on Lie groups. It estimates a Lie group state $g \in G$ and a manifold state $\xi \in M$, using a symmetry principle where the error dynamics are autonomous in a specific frame. This class inherits from ```ManifoldEKF```.
@@ -211,7 +211,7 @@ Below are four examples of these filters in action.
211211
1) **[IEKF_SE2Example](https://github.com/borglab/gtsam/blob/develop/examples/IEKF_SE2Example.cpp)**: implements ```InvariantEKF``` on a SE(2) Lie Group with odometry as a Lie group increment and a 2D GPS measurement update.
212212
2) **[IEKF_NavstateExample](https://github.com/borglab/gtsam/blob/develop/examples/IEKF_NavstateExample.cpp)**: implements ```InvariantEKF``` on a NavState Lie Group with a tangent space increment based on IMU measurements, and a 3D GPS measuremnt update.
213213
3) **[GEKF_Rot3Example](https://github.com/borglab/gtsam/blob/develop/examples/GEKF_Rot3Example.cpp)**: implements ```LieGroupEKF``` on a Rot3 Lie Group using a state dependent dynamics function and a magnetometer update.
214-
4) **[NavStateImuExample](https://github.com/borglab/gtsam/blob/develop/examples/NavStateImuExample.cpp)** and the accompanying notebooks: [user guide](gtsam/navigation/doc/NavStateImuEKF.ipynb) and a [full tutorial](python/gtsam/examples/NavStateImuExample.ipynb) demonstrate the NavStateImuEKF.
214+
4) **[NavStateImuExample](https://github.com/borglab/gtsam/blob/develop/examples/NavStateImuExample.cpp)** and the accompanying notebooks: [user guide](https://borglab.github.io/gtsam/navstateimuekf/) and a [full tutorial](https://borglab.github.io/gtsam/navstateimuexample/) demonstrate the NavStateImuEKF.
215215
5) **[testEquivariantFilter](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/tests/testEquivariantFilter.cpp)**: implements ```EquivariantFilter``` on a SO(3) attitude-only system. A more complex **[ABC example](https://github.com/borglab/gtsam/blob/develop/examples/AbcEquivariantFilterExample.cpp)** is also available.
216216

217217

@@ -503,4 +503,3 @@ classDiagram
503503

504504

505505

506-

gtsam/navigation/doc/Gal3ImuEKF.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@
298298
"## Full examples and plotting\n",
299299
"\n",
300300
"For a step-by-step tutorial with scenarios, plots, and uncertainty bands, see:\n",
301-
"- Gal3 IMU EKF Tutorial: https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/Gal3ImuExample.ipynb"
301+
"- Gal3 IMU EKF Tutorial: https://borglab.github.io/gtsam/gal3imuexample/"
302302
]
303303
},
304304
{
@@ -336,4 +336,4 @@
336336
},
337337
"nbformat": 4,
338338
"nbformat_minor": 5
339-
}
339+
}

gtsam/navigation/doc/InvariantEKF.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@
105105
"## Where it is used today\n",
106106
"- C++ tests: [gtsam/navigation/tests/testInvariantEKF.cpp](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/tests/testInvariantEKF.cpp) exercises `predict(U, Q)` and the `dt` overload.\n",
107107
"- C++ examples: [examples/IEKF_NavstateExample.cpp](https://github.com/borglab/gtsam/blob/develop/examples/IEKF_NavstateExample.cpp) (NavState), [examples/GEKF_Rot3Example.cpp](https://github.com/borglab/gtsam/blob/develop/examples/GEKF_Rot3Example.cpp) (LieGroupEKF on SO(3)).\n",
108-
"- Docs: [gtsam/navigation/doc/InvariantEKF.md](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/doc/InvariantEKF.md) (math/background).\n",
108+
"- Docs: [EKF Variants](https://borglab.github.io/gtsam/ekf-variants/) (math/background).\n",
109109
"- Python notebooks with IMU-specialized EKFs built on the same interface:\n",
110-
" - [python/gtsam/examples/NavStateImuASVExample.ipynb](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/NavStateImuASVExample.ipynb)\n",
111-
" - [python/gtsam/examples/Gal3ImuExample.ipynb](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/Gal3ImuExample.ipynb)\n",
112-
" - [python/gtsam/examples/Gal3ImuASVExample.ipynb](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/Gal3ImuASVExample.ipynb)\n",
110+
" - [python/gtsam/examples/NavStateImuASVExample.ipynb](https://borglab.github.io/gtsam/navstateimuasvexample/)\n",
111+
" - [python/gtsam/examples/Gal3ImuExample.ipynb](https://borglab.github.io/gtsam/gal3imuexample/)\n",
112+
" - [python/gtsam/examples/Gal3ImuASVExample.ipynb](https://borglab.github.io/gtsam/gal3imuasvexample/)\n",
113113
"\n",
114114
"If you add new examples that use `predict(W, U, Q)`, please link them here for discoverability."
115115
]

gtsam/navigation/doc/NavStateImuEKF.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"- Adding a world-position measurement with the correct Jacobian H = [0, R, 0].\n",
2020
"- Visualizing results with ±2σ uncertainty bands and basic tuning.\n",
2121
"\n",
22-
"See also: [NavState IMU EKF Tutorial](https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/NavStateImuExample.ipynb) for a longer, step-by-step walkthrough."
22+
"See also: [NavState IMU EKF Tutorial](https://borglab.github.io/gtsam/navstateimuexample/) for a longer, step-by-step walkthrough."
2323
]
2424
},
2525
{
@@ -241,7 +241,7 @@
241241
"## Full examples and plotting\n",
242242
"\n",
243243
"For a step-by-step tutorial with scenarios, plots, and uncertainty bands, see:\n",
244-
"- NavState IMU EKF Tutorial: https://github.com/borglab/gtsam/blob/develop/python/gtsam/examples/NavStateImuExample.ipynb"
244+
"- NavState IMU EKF Tutorial: https://borglab.github.io/gtsam/navstateimuexample/"
245245
]
246246
},
247247
{
@@ -296,4 +296,4 @@
296296
},
297297
"nbformat": 4,
298298
"nbformat_minor": 5
299-
}
299+
}

python/gtsam/examples/DifferentialPseudorangeExample.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@
371371
"## Sources\n",
372372
"- [PseudorangeFactor.h](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/PseudorangeFactor.h)\n",
373373
"- [PseudorangeFactor.cpp](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/PseudorangeFactor.cpp)\n",
374-
"- [PseudorangeFactor.ipynb](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/doc/PseudorangeFactor.ipynb)\n",
374+
"- [PseudorangeFactor.ipynb](https://borglab.github.io/gtsam/pseudorangefactor/)\n",
375375
"- [SinglePointPositioningExample.ipynb](https://borglab.github.io/gtsam/singlepointpositioningexample/)"
376376
]
377377
}

python/gtsam/examples/SinglePointPositioningExample.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
"## Sources\n",
243243
"- [PseudorangeFactor.h](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/PseudorangeFactor.h)\n",
244244
"- [PseudorangeFactor.cpp](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/PseudorangeFactor.cpp)\n",
245-
"- [PseudorangeFactor.ipynb](https://github.com/borglab/gtsam/blob/develop/gtsam/navigation/doc/PseudorangeFactor.ipynb)"
245+
"- [PseudorangeFactor.ipynb](https://borglab.github.io/gtsam/pseudorangefactor/)"
246246
]
247247
}
248248
],

0 commit comments

Comments
 (0)