Skip to content

Commit

Permalink
Relocate auto-generated doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@phausamann
phausamann committed Jun 7, 2021
1 parent f5a803d commit 7fa7fd1
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 104 deletions.
8 changes: 4 additions & 4 deletions docs/api/reference_frames.rst
View file
Expand Up @@ -11,7 +11,7 @@ Construction

.. autosummary::
:nosignatures:
:toctree: _generated
:toctree: ../_generated

ReferenceFrame.from_dataset
ReferenceFrame.from_translation_dataarray
Expand All @@ -23,7 +23,7 @@ Transforms

.. autosummary::
:nosignatures:
:toctree: _generated
:toctree: ../_generated

ReferenceFrame.transform_points
ReferenceFrame.transform_quaternions
Expand All @@ -36,7 +36,7 @@ Lookups

.. autosummary::
:nosignatures:
:toctree: _generated
:toctree: ../_generated

ReferenceFrame.lookup_transform
ReferenceFrame.lookup_angular_velocity
Expand All @@ -49,7 +49,7 @@ Registry

.. autosummary::
:nosignatures:
:toctree: _generated
:toctree: ../_generated

ReferenceFrame.register
ReferenceFrame.deregister
62 changes: 31 additions & 31 deletions docs/estimators.ipynb
View file
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "cosmetic-causing",
"id": "diverse-gallery",
"metadata": {},
"source": [
"# Estimating transforms from data\n",
Expand All @@ -12,7 +12,7 @@
},
{
"cell_type": "markdown",
"id": "systematic-accreditation",
"id": "international-ceramic",
"metadata": {},
"source": [
"<div class=\"alert alert-info\">\n",
Expand All @@ -25,7 +25,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "ancient-quick",
"id": "demonstrated-charleston",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -39,7 +39,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "superior-mauritius",
"id": "placed-holly",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -48,7 +48,7 @@
},
{
"cell_type": "markdown",
"id": "everyday-ivory",
"id": "satisfactory-politics",
"metadata": {},
"source": [
"## Shortest arc rotation\n",
Expand All @@ -59,7 +59,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "determined-election",
"id": "brief-representative",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -70,7 +70,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "precise-customer",
"id": "disabled-petroleum",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -86,7 +86,7 @@
},
{
"cell_type": "markdown",
"id": "coated-tracy",
"id": "identical-montreal",
"metadata": {},
"source": [
"The quaternion $r$ that rotates $v_1$ in the same direction as $v_2$, i.e., that satisfies:\n",
Expand All @@ -99,7 +99,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "beginning-cylinder",
"id": "romance-phrase",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -108,7 +108,7 @@
},
{
"cell_type": "markdown",
"id": "sharp-photography",
"id": "arctic-rental",
"metadata": {},
"source": [
"The method also works with arrays of vectors. Let's first construct an array of progressive rotations around the yaw axis with the [from_euler_angles()](_generated/rigid_body_motion.from_euler_angles.rst) method:"
Expand All @@ -117,7 +117,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "confidential-satin",
"id": "otherwise-russell",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -126,7 +126,7 @@
},
{
"cell_type": "markdown",
"id": "crude-strategy",
"id": "split-sodium",
"metadata": {},
"source": [
"Now we can rotate $v_2$ with $r$. Because we rotate a single vector with multiple quaternions we have to specify `one_to_one=False`:"
Expand All @@ -135,7 +135,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "premier-porcelain",
"id": "certain-armstrong",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -145,7 +145,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "level-destruction",
"id": "sunset-accused",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -161,7 +161,7 @@
},
{
"cell_type": "markdown",
"id": "acceptable-guinea",
"id": "opponent-transition",
"metadata": {},
"source": [
"[shortest_arc_rotation()](_generated/rigid_body_motion.shortest_arc_rotation.rst) now returns an array of quaternions:"
Expand All @@ -170,7 +170,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "narrative-assignment",
"id": "placed-circumstances",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -179,7 +179,7 @@
},
{
"cell_type": "markdown",
"id": "sophisticated-swift",
"id": "suspended-irish",
"metadata": {},
"source": [
"## Best fit rotation\n",
Expand All @@ -190,7 +190,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "selected-carnival",
"id": "italic-comparison",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -200,7 +200,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "stylish-location",
"id": "express-investment",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -216,7 +216,7 @@
},
{
"cell_type": "markdown",
"id": "forbidden-works",
"id": "metallic-offset",
"metadata": {},
"source": [
"The rotation between the vectors can be found with a least-squares minimization:\n",
Expand All @@ -229,7 +229,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "australian-cathedral",
"id": "italian-thousand",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -238,7 +238,7 @@
},
{
"cell_type": "markdown",
"id": "possible-ideal",
"id": "pressing-indianapolis",
"metadata": {},
"source": [
"## Best fit transform\n",
Expand All @@ -249,7 +249,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "compatible-fortune",
"id": "interior-values",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -259,7 +259,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "fatty-concert",
"id": "pursuant-excuse",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -271,7 +271,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "spiritual-transportation",
"id": "willing-sixth",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -287,7 +287,7 @@
},
{
"cell_type": "markdown",
"id": "previous-julian",
"id": "confused-color",
"metadata": {},
"source": [
"To estimate this transform, we can minimize:\n",
Expand All @@ -300,7 +300,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "scenic-leisure",
"id": "announced-warning",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -309,7 +309,7 @@
},
{
"cell_type": "markdown",
"id": "funny-swedish",
"id": "understanding-dayton",
"metadata": {},
"source": [
"## Iterative closest point\n",
Expand All @@ -320,7 +320,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "strong-judgment",
"id": "atomic-architect",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -329,7 +329,7 @@
},
{
"cell_type": "markdown",
"id": "offensive-boring",
"id": "royal-removal",
"metadata": {},
"source": [
"Note that there is a discrepancy in the estimated transform compared to the best fit transform. ICP usually yields better results with a larger number of points that have more spatial structure."
Expand All @@ -352,7 +352,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.13"
"version": "3.8.10"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 7fa7fd1

Please sign in to comment.