Struct efd::PosedEfd

pub struct PosedEfd<const D: usize>
where
    U<D>: EfdDim<D>,
{ /* private fields */ }

A shape with a pose described by EFD.

These are the same as Efd except that it has a pose, and the data are always normalized and readonly.

Start with PosedEfd::from_series() and its related methods.

Pose Representation

Pose is represented by an unit vector, which is rotated by the rotation of the original shape.

Implementations

impl PosedEfd<2>

pub fn from_angles<C>(curve: C, angles: &[f64], is_open: bool) -> Self

where C: Curve<2>,

Calculate the coefficients from a curve and its angles from each point.

pub fn from_angles_harmonic<C>( curve: C, angles: &[f64], is_open: bool, harmonic: usize ) -> Self

where C: Curve<2>,

Calculate the coefficients from a curve and its angles from each point.

The harmonic is the number of the coefficients to be calculated.

impl<const D: usize> PosedEfd<D>

where U<D>: EfdDim<D>,

pub const fn from_parts_unchecked(curve: Efd<D>, pose: Efd<D>) -> Self

Create a new PosedEfd from two Efds. (curve and pose)

See also PosedEfd::into_inner().

pub fn from_series<C1, C2>(curve1: C1, curve2: C2, is_open: bool) -> Self

where C1: Curve<D>, C2: Curve<D>,

Calculate the coefficients from two series of points.

The second series is the pose series, the curve2[i] has the same time as curve[i].

pub fn from_series_harmonic<C1, C2>( curve1: C1, curve2: C2, is_open: bool, harmonic: usize ) -> Self

where C1: Curve<D>, C2: Curve<D>,

Calculate the coefficients from two series of points.

The harmonic is the number of the coefficients to be calculated.

pub fn from_uvec<C, V>(curve: C, vectors: V, is_open: bool) -> Self

where C: Curve<D>, V: Curve<D>,

Calculate the coefficients from a curve and its unit vectors from each point.

See also PosedEfd::from_uvec_unchecked() if you want to skip the unit vector calculation.

pub fn from_uvec_harmonic<C, V>( curve: C, vectors: V, is_open: bool, harmonic: usize ) -> Self

where C: Curve<D>, V: Curve<D>,

Calculate the coefficients from a curve and its unit vectors from each point.

See also PosedEfd::from_uvec_harmonic_unchecked() if you want to skip the unit vector calculation.

pub fn from_uvec_unchecked<C, V>(curve: C, vectors: V, is_open: bool) -> Self

where C: Curve<D>, V: Curve<D>,

Calculate the coefficients from a curve and its unit vectors from each point.

pub fn from_uvec_harmonic_unchecked<C, V>( curve: C, vectors: V, is_open: bool, harmonic: usize ) -> Self

where C: Curve<D>, V: Curve<D>,

Calculate the coefficients from a curve and its unit vectors from each point.

The harmonic is the number of the coefficients to be calculated.

pub fn fourier_power_anaysis<T>(self, threshold: T) -> Self

where Option<f64>: From<T>,

Use Fourier Power Anaysis (FPA) to reduce the harmonic number.

The default threshold is 99.99%.

See also Efd::fourier_power_anaysis().

Panics

Panics if the threshold is not in 0..1, or the harmonic is zero.

pub fn set_harmonic(&mut self, harmonic: usize)

Set the harmonic number of the coefficients.

Panics

Panics if the harmonic is zero or greater than the current harmonic.

pub fn into_inner(self) -> (Efd<D>, Efd<D>)

Consume self and return the parts of this type. The first is the curve coefficients, and the second is the pose coefficients.

See also PosedEfd::from_parts_unchecked().

pub fn is_open(&self) -> bool

Check if the described curve is open.

pub fn harmonic(&self) -> usize

Get the harmonic number of the coefficients.

pub fn is_valid(&self) -> bool

Check if the coefficients are valid.

It is only helpful if this object is constructed by PosedEfd::from_parts_unchecked().

pub fn distance(&self, rhs: &Self) -> f64

Calculate the L1 distance between two coefficient set.

For more distance methods, please see Distance.

pub fn curve_efd(&self) -> &Efd<D>

Get a reference to the curve coefficients.

pub fn pose_efd(&self) -> &Efd<D>

Get a reference to the posed coefficients.

pub fn generate(&self, n: usize, len: f64) -> (Vec<Coord<D>>, Vec<Coord<D>>)

Obtain the curve and pose for visualization.

The len is the length of the pose vector.

pub fn generate_half( &self, n: usize, len: f64 ) -> (Vec<Coord<D>>, Vec<Coord<D>>)

Obtain the curve and pose for visualization in half range.

The len is the length of the pose vector.

pub fn generate_by(&self, t: &[f64], len: f64) -> (Vec<Coord<D>>, Vec<Coord<D>>)

Obtain the curve and pose for visualization from a series of time t.

Trait Implementations

impl<const D: usize> Clone for PosedEfd<D>

where U<D>: EfdDim<D>,

fn clone(&self) -> PosedEfd<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for PosedEfd<D>

where U<D>: EfdDim<D>,

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

Formats the value using the given formatter.

impl<const D: usize> Distance for PosedEfd<D>

where U<D>: EfdDim<D>,

fn err_buf(&self, rhs: &Self) -> Vec<f64>

Calculate the error between each pair of datas.

fn square_err(&self, rhs: &Self) -> f64

Calculate the square error.

fn l0_norm(&self, rhs: &Self) -> f64

Calculate the L0 norm of the error.

fn l1_norm(&self, rhs: &Self) -> f64

Calculate the L1 norm of the error.

fn l2_norm(&self, rhs: &Self) -> f64

Calculate the L2 norm of the error.

fn lp_norm(&self, rhs: &Self, p: i32) -> f64

Calculate the Lp norm of the error.