Skip to main content

KltTracker

Struct KltTracker 

Source
pub struct KltTracker {
    pub config: KltConfig,
}
Expand description

Pyramidal KLT tracker.

Fields§

§config: KltConfig

Tracker configuration.

Implementations§

Source§

impl KltTracker

Source

pub fn new(config: KltConfig) -> Self

Create a new KLT tracker with the given configuration.

Source

pub fn track_features( &self, prev_frame: &[u8], curr_frame: &[u8], width: u32, height: u32, points: &[(f32, f32)], ) -> AlignResult<Vec<Option<(f32, f32)>>>

Track sparse feature points from prev_frame to curr_frame using pyramidal Lucas-Kanade optical flow.

This is the primary high-level API for KLT tracking. It accepts f32 pixel coordinates (common in feature-detection pipelines) and returns Some((x, y)) for successfully tracked points or None when tracking failed (low texture, out-of-bounds, etc.).

Both frames must be single-channel (grayscale), row-major byte images of size width * height.

§Errors

Returns an error if image dimensions are inconsistent or the frame is smaller than 8×8 pixels.

Source

pub fn track( &self, prev_image: &[u8], curr_image: &[u8], width: usize, height: usize, points: &[Point2D], ) -> AlignResult<Vec<TrackResult>>

Track a set of points from prev_image to curr_image.

Both images must be single-channel (grayscale), row-major, with the same width and height.

§Errors

Returns an error if the image dimensions are inconsistent.

Trait Implementations§

Source§

impl Default for KltTracker

Source§

fn default() -> Self

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> 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, 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.