Skip to main content

KSvd

Struct KSvd 

Source
pub struct KSvd {
    pub n_atoms: usize,
    pub sparsity: usize,
    pub n_iter: usize,
}
Expand description

K-SVD dictionary learning algorithm.

Alternates between a sparse coding stage (OMP) and a dictionary update stage (rank-1 SVD update) to learn an overcomplete dictionary adapted to training data.

Reference: Aharon, Elad & Bruckstein (2006).

Fields§

§n_atoms: usize

Number of dictionary atoms (columns).

§sparsity: usize

Target sparsity per signal.

§n_iter: usize

Number of training iterations.

Implementations§

Source§

impl KSvd

Source

pub fn new(n_atoms: usize, sparsity: usize, n_iter: usize) -> Self

Create a new K-SVD learner.

  • n_atoms — number of dictionary atoms
  • sparsity — maximum number of atoms per signal
  • n_iter — number of alternating optimisation iterations
Source

pub fn fit(&self, signals: &[Vec<f64>]) -> Vec<Vec<f64>>

Learn a dictionary from training signals.

  • signals — list of training signals (each of the same length d)

Returns a dictionary matrix D of shape d × n_atoms (columns are atoms, stored as Vec<Vecf64> in row-major form, i.e. D[i][j] is row i, atom j).

Source

pub fn encode(&self, dict: &[Vec<f64>], signal: &[f64]) -> Vec<f64>

Encode a single signal using the learned dictionary.

Returns a sparse coefficient vector of length n_atoms.

Source

pub fn reconstruct(dict: &[Vec<f64>], code: &[f64]) -> Vec<f64>

Reconstruct a signal from its sparse code and dictionary.

Returns D c where D is the dictionary and c is the code.

Auto Trait Implementations§

§

impl Freeze for KSvd

§

impl RefUnwindSafe for KSvd

§

impl Send for KSvd

§

impl Sync for KSvd

§

impl Unpin for KSvd

§

impl UnsafeUnpin for KSvd

§

impl UnwindSafe for KSvd

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