Crate efd

EFD Rust Library

Elliptical Fourier Descriptor (EFD) implementation in Rust. This crate implements 2D/3D EFD and its related functions.

Keyword Alias:

• Elliptical Fourier Analysis (EFA)
• Elliptical Fourier Function (EFF)

Reference: Kuhl, FP and Giardina, CR (1982). Elliptic Fourier features of a closed contour. Computer graphics and image processing, 18(3), 236-258.

This is an unofficial implementation.

@article{kuhl1982elliptic,
  title={Elliptic Fourier features of a closed contour},
  author={Kuhl, Frank P and Giardina, Charles R},
  journal={Computer graphics and image processing},
  volume={18},
  number={3},
  pages={236--258},
  year={1982},
  publisher={Elsevier}
}

Example of re-describing a new closed curve:

let curve = vec![
    [0., 0.],
    [1., 1.],
    [2., 2.],
    [3., 3.],
    [2., 2.],
    [1., 1.],
];
assert!(efd::valid_curve(&curve).is_some());
let described_curve = efd::Efd2::from_curve(curve, false).generate(20);

Features

This crate support no-std solution via using “libm”, a crate provide pure-rust math functions. Disable the “std” feature will automatic enable it.

Re-exports

• pub extern crate nalgebra as na;

Structs

• Efd
  Elliptical Fourier Descriptor coefficients. Provide transformation between discrete points and coefficients.
• Transform
  Transform type.

Enums

• D2
  2D EFD dimension marker.
• D3
  3D EFD dimension marker.

Traits

• CoordHint
  Hint for transforming coordinate type to matrix.
• Curve
  Copy-on-write curve type.
• EfdDim
  Trait for EFD dimension.
• Trans
  A trait used in inner type of Transform.

Functions

• curve_diff
  Curve difference between two curves using interpolation.
• curve_diff_res
  Custom resolution of curve_diff function.
• partial_curve_diff
  Coordinate difference between two curves using interpolation.
• partial_curve_diff_res
  Custom resolution of partial_curve_diff function.
• valid_curve
  Check if the curve is valid.

Type Definitions

• CDim
  Alias for the coefficient number. (DIM * 2)
• CKernel
  A matrix view of specific coefficients. (DIM * 2)
• CKernelMut
  A mutable matrix view of specific coefficients. (DIM * 2)
• Coeff
  Coefficient type.
• Coeff2
  2D Coefficient type.
• Coeff3
  3D Coefficient type.
• Coord
  Alias for evaluate EfdDim::Trans::Coord from D.
• CoordView
  Coordinate view used in the conversion method.
• Dim
  Alias for the dimension.
• Efd2
  2D EFD coefficients type.
• Efd3
  3D EFD coefficients type.
• T2
  2D transformation inner type.
• T3
  3D transformation inner type.
• Transform2
  2D transformation type.
• Transform3
  3D transformation type.