mapping_algorithms::point_clouds

Enum ICPError

pub enum ICPError<T: Scalar, const N: usize> {
    SourcePointCloudEmpty,
    TargetPointCloudEmpty,
    NoNearestNeighbour,
    IterationNumIsZero,
    MSEIntervalThreshold,
    MSEAbsoluteThreshold,
    IterationDidNotConverge((Point<T, N>, Point<T, N>)),
    AlrogithmDidNotConverge,
}

Expand description

An error type containing the various errors that might arise during an ICP algorithm, when compiling with the std feature, it will also derive thiserror::Error.

Variants§

SourcePointCloudEmpty

The source point cloud is empty.

TargetPointCloudEmpty

The target point cloud is empty.

NoNearestNeighbour

A source point had no nearest neighbour in the target point cloud.

IterationNumIsZero

The amount of iterations was set to zero.

MSEIntervalThreshold

The Mean Squared Error interval threshold was set to zero.

MSEAbsoluteThreshold

The Mean Squared Error absolute threshold was set to zero.

IterationDidNotConverge((Point<T, N>, Point<T, N>))

The Current iteration did not converge, returns the current mean points.

AlrogithmDidNotConverge

The algorithm did not converge after the maximum amount of iterations.

Trait Implementations§

impl<T: Clone + Scalar, const N: usize> Clone for ICPError<T, N>

fn clone(&self) -> ICPError<T, N>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug + Scalar, const N: usize> Debug for ICPError<T, N>

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

Formats the value using the given formatter. Read more

impl<T: Scalar, const N: usize> Error for ICPError<T, N>
where Self: Debug + Display,

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports. Read more

impl<T: PartialEq + Scalar, const N: usize> PartialEq for ICPError<T, N>

fn eq(&self, other: &ICPError<T, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy + Scalar, const N: usize> Copy for ICPError<T, N>

impl<T: Eq + Scalar, const N: usize> Eq for ICPError<T, N>

impl<T: Scalar, const N: usize> StructuralPartialEq for ICPError<T, N>

Auto Trait Implementations§

impl<T, const N: usize> Freeze for ICPError<T, N>
where T: Freeze,

impl<T, const N: usize> RefUnwindSafe for ICPError<T, N>
where T: RefUnwindSafe,

impl<T, const N: usize> Send for ICPError<T, N>
where T: Send,

impl<T, const N: usize> Sync for ICPError<T, N>
where T: Sync,

impl<T, const N: usize> Unpin for ICPError<T, N>
where T: Unpin,

impl<T, const N: usize> UnwindSafe for ICPError<T, N>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,