Skip to main content

PoseGraph

Struct PoseGraph 

Source
pub struct PoseGraph { /* private fields */ }
Expand description

Nodes, edges, and the optimisation over them.

Implementations§

Source§

impl PoseGraph

Source

pub fn new(poses: Vec<Se3>) -> Self

A graph with these nodes and no edges.

Source

pub fn poses(&self) -> &[Se3]

The nodes, in order.

Source

pub fn edges(&self) -> &[Edge]

The edges, in the order they were added.

Source

pub fn push(&mut self, edge: Edge) -> Result<(), GraphError>

Adds an edge, refusing one that names a node that is not there.

Source

pub fn shape(&self, anchor: usize) -> Shape

What shape the edges make, which decides what a solve can do.

Reported rather than discovered by failing: a survey with a node nothing joins to the anchor is one the normal equations cannot factorise, and finding that out from GraphError::Singular after the solve is a worse way to learn it than being told before.

Source

pub fn residual(&self, edge: &Edge) -> Vector6<f64>

The disagreement on one edge: log(T_i⁻¹·T_j·Z⁻¹).

Zero when the two nodes sit exactly as the measurement says. The ordering — the measurement inverted on the right — is what puts the residual in the same frame and the same left-perturbation convention as the information matrix beside it.

Source

pub fn cost(&self) -> f64

Σ rᵀΛr over the edges.

Source

pub fn optimise( &mut self, params: &OptimiseParams, ) -> Result<Report, GraphError>

Levenberg-damped Gauss–Newton until the steps stop mattering.

Source§

impl PoseGraph

Source

pub fn diagnose(&self, anchor: usize) -> Result<Diagnosis, GraphError>

What the survey looks like from above, at the poses it currently has.

Node spreads come from the pseudo-inverse of H = ΣJᵀΛJ, whose diagonal blocks are each station’s marginal covariance relative to the anchor. Pseudo- rather than plain inverse, and that is the whole point: a survey with a direction nothing constrains has a singular H, which is not an error to be damped away but the finding. A damped inverse would answer “this station is known to a centimetre” where the truth is that nothing in the survey knows where it is.

The null space is left out of the sum rather than inverted into infinities. Building V·diag(∞)·Vᵀ and reading blocks out of it does not give infinity where it should — an eigenvector component that is exactly zero turns ∞·0 into NaN, and the NaNs spread into the blocks of stations the survey determines perfectly well. Which coordinates are unconstrained is asked separately, of how much of each lies in the null space.

The cutoff is relative, at 1e-12 of the largest eigenvalue — the same shape of judgement the conditioning report makes about a single registration, one level up.

Trait Implementations§

Source§

impl Clone for PoseGraph

Source§

fn clone(&self) -> PoseGraph

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PoseGraph

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PoseGraph

Source§

fn default() -> PoseGraph

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.