1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
use crate::{util::*, *};
use alloc::{format, vec::Vec};
use core::f64::consts::{PI, TAU};
/// A 1D shape described by EFD.
pub type Efd1 = Efd<1>;
/// A 2D shape described by EFD.
pub type Efd2 = Efd<2>;
/// A 3D shape described by EFD.
pub type Efd3 = Efd<3>;
/// Calculate the number of harmonics.
///
/// The number of harmonics is calculated by the minimum length of the curves.
/// And if the curve is open, the number is doubled.
/// ```
/// let is_open = true;
/// assert_eq!(efd::harmonic(is_open, 3), 6);
/// ```
/// See also [`Efd::from_curve_harmonic()`].
#[inline]
pub const fn harmonic(is_open: bool, len: usize) -> usize {
if is_open {
len * 2
} else {
len
}
}
/// Calculate the number of harmonics with the Nyquist frequency.
///
/// This macro is similar to [`harmonic()`], but the number of harmonics is half
/// if the given curve meets the Nyquist–Shannon sampling theorem.
/// ```
/// let is_open = false;
/// assert_eq!(efd::harmonic_nyquist(is_open, 6), 3);
/// ```
/// See also [`harmonic()`] and [`Efd::from_curve_nyquist()`].
#[inline]
pub const fn harmonic_nyquist(is_open: bool, len: usize) -> usize {
harmonic(is_open, len) / 2
}
/// Get the normalized time parameters of the curve.
///
/// Same as `PathSig::new(curve, is_open).t`.
///
/// See also [`PathSig`].
pub fn get_norm_t<C, const D: usize>(curve: C, is_open: bool) -> Vec<f64>
where
C: Curve<D>,
U<D>: EfdDim<D>,
{
PathSig::new(curve, is_open).t
}
/// Path signature with the target position.
///
/// Use to present an "original path". Can be compared with [`Efd`] by
/// [`Efd::err_sig()`].
///
/// See also [`get_norm_t()`].
#[derive(Clone)]
pub struct PathSig<const D: usize>
where
U<D>: EfdDim<D>,
{
/// Normalized curve
pub curve: Vec<[f64; D]>,
/// Normalized time parameters
pub t: Vec<f64>,
/// Geometric variables
pub geo: GeoVar<Rot<D>, D>,
}
impl<const D: usize> PathSig<D>
where
U<D>: EfdDim<D>,
{
/// Get the time parameter `t` of each point coordinate and the normalized
/// geometric variables of the curve.
///
/// This function is faster than building [`Efd`] since it only calculates
/// **two harmonics**.
///
/// ```
/// let curve = [[0., 0.], [1., 0.], [1., 1.], [0., 1.]];
/// let sig = efd::PathSig::new(curve, true);
/// ```
pub fn new<C>(curve: C, is_open: bool) -> Self
where
C: Curve<D>,
{
let (Efd { mut coeffs, geo }, mut t) = Efd::get_all_unnorm(curve.as_curve(), is_open, 2);
let geo = geo * U::norm_coeff(&mut coeffs, Some(&mut t));
let curve = geo.inverse().transform(curve);
Self { curve, t, geo }
}
/// Get the reference of normalized time parameters.
pub fn as_t(&self) -> &[f64] {
&self.t
}
/// Get the reference of geometric variables.
pub fn as_geo(&self) -> &GeoVar<Rot<D>, D> {
&self.geo
}
}
/// Elliptical Fourier Descriptor coefficients.
/// Provide transformation between discrete points and coefficients.
///
/// Start with [`Efd::from_curve()`] and its related methods.
///
/// # Normalization
/// The geometric normalization of EFD coefficients.
///
/// Implements Kuhl and Giardina method of normalizing the coefficients
/// An, Bn, Cn, Dn. Performs 3 separate normalizations. First, it makes the
/// data location invariant by re-scaling the data to a common origin.
/// Secondly, the data is rotated with respect to the major axis. Thirdly,
/// the coefficients are normalized with regard to the absolute value of A₁.
///
/// Please see [`Efd::as_geo()`] and [`GeoVar`] for more information.
#[derive(Clone)]
pub struct Efd<const D: usize>
where
U<D>: EfdDim<D>,
{
coeffs: Coeffs<D>,
geo: GeoVar<Rot<D>, D>,
}
impl<const D: usize> Efd<D>
where
U<D>: EfdDim<D>,
{
/// Create object from coefficients and geometric variables.
///
/// # Raw Coefficients
/// There is no "check method" for the input coefficients. Please use
/// [`Efd::from_curve()`] and its related methods to create the object. This
/// method is designed for loading coefficients from external sources.
///
/// See also [`Efd::from_coeffs_unchecked()`] and [`Efd::into_inner()`].
///
/// # Panics
/// Panics if the harmonic is zero. (`coeffs.len() == 0`)
/// ```should_panic
/// use efd::{Efd2, GeoVar};
/// let curve = Efd2::from_parts_unchecked(vec![], GeoVar::identity()).recon(20);
/// ```
pub fn from_parts_unchecked(coeffs: Coeffs<D>, geo: GeoVar<Rot<D>, D>) -> Self {
assert!(!coeffs.is_empty(), "the harmonic must be greater than 0");
Self { coeffs, geo }
}
/// Create object from coefficients without check.
///
/// # Panics
/// Panics if the harmonic is zero. (`coeffs.len() == 0`)
pub fn from_coeffs_unchecked(coeffs: Coeffs<D>) -> Self {
Self::from_parts_unchecked(coeffs, GeoVar::identity())
}
/// Fully automated coefficient calculation.
///
/// 1. The initial harmonic number is the same as the curve point.
/// 1. Fourier Power Anaysis (FPA) uses 99.99% threshold.
///
/// # Tail End Closed
/// If `curve.first() != curve.last()`, the curve will be automatically
/// closed when `is_open` is false.
///
/// # Open Curve Option
/// The open curve option is for the curve that duplicated a reversed part
/// of itself. For example,
/// ```
/// # let curve_open = efd::tests::CURVE2D_OPEN.to_vec();
/// let efd = efd::Efd2::from_curve(curve_open, true);
/// ```
/// is equivalent to
/// ```
/// # let curve_open = efd::tests::CURVE2D_OPEN.to_vec();
/// let curve_closed = curve_open
/// .iter()
/// .chain(curve_open.iter().rev().skip(1))
/// .cloned()
/// .collect::<Vec<_>>();
/// let efd = efd::Efd2::from_curve(curve_closed, false);
/// ```
/// but not actually increase the data size.
///
/// # Panics
/// Panics if the curve length is not greater than 2 in debug mode. This
/// function check the lengths only. Please use [`valid_curve()`] to verify
/// the curve if there has NaN input.
pub fn from_curve<C>(curve: C, is_open: bool) -> Self
where
C: Curve<D>,
{
let harmonic = harmonic(is_open, curve.len());
Self::from_curve_harmonic(curve, is_open, harmonic).fourier_power_anaysis(None)
}
/// Same as [`Efd::from_curve()`], but if your sampling points are large,
/// use Nyquist Frequency as the initial harmonic number.
///
/// Please ensure the sampling points meet the [Nyquist–Shannon sampling theorem](https://en.wikipedia.org/wiki/Nyquist%E2%80%93Shannon_sampling_theorem).
///
/// See also [`harmonic_nyquist`].
pub fn from_curve_nyquist<C>(curve: C, is_open: bool) -> Self
where
C: Curve<D>,
{
let harmonic = harmonic_nyquist(is_open, curve.len());
Self::from_curve_harmonic(curve, is_open, harmonic).fourier_power_anaysis(None)
}
/// Manual coefficient calculation.
///
/// 1. The initial harmonic is decided by user.
/// + [`harmonic()`] is used in [`Efd::from_curve()`].
/// + [`harmonic_nyquist()`] is used in [`Efd::from_curve_nyquist()`].
/// 1. No harmonic reduced.
/// + Please call [`Efd::fourier_power_anaysis()`] manually.
///
/// # Panics
/// Panics if the specific harmonic is zero or the curve length is not
/// greater than 2 in the **debug mode**. This function check the lengths
/// only. Please use [`valid_curve()`] to verify the curve if there has NaN
/// input.
pub fn from_curve_harmonic<C>(curve: C, is_open: bool, harmonic: usize) -> Self
where
C: Curve<D>,
{
Self::from_curve_harmonic_unnorm(curve, is_open, harmonic).normalized()
}
/// Same as [`Efd::from_curve_harmonic()`] but without normalization.
///
/// Please call [`Efd::normalized()`] if you want to normalize later.
pub fn from_curve_harmonic_unnorm<C>(curve: C, is_open: bool, harmonic: usize) -> Self
where
C: Curve<D>,
{
Self::get_all_unnorm(curve, is_open, harmonic).0
}
#[track_caller]
fn get_all_unnorm<C>(curve: C, is_open: bool, harmonic: usize) -> (Self, Vec<f64>)
where
C: Curve<D>,
{
debug_assert!(harmonic != 0, "harmonic must not be 0");
debug_assert!(curve.len() > 2, "the curve length must greater than 2");
let (t, coeffs, geo) = U::get_coeff(curve.as_curve(), is_open, harmonic, None);
(Self { coeffs, geo }, t)
}
/// A builder method using Fourier Power Anaysis (FPA) to reduce the
/// harmonic number.
///
/// The coefficient memory will be saved but cannot be used multiple times
/// due to undersampling.
///
/// The default threshold is 99.99%.
///
/// See also [`Efd::fpa_inplace()`].
///
/// # Panics
/// Panics if the threshold is not in 0..1, or the harmonic is zero.
pub fn fourier_power_anaysis(mut self, threshold: impl Into<Option<f64>>) -> Self {
self.fpa_inplace(threshold);
self
}
/// Fourier Power Anaysis (FPA) function with in-place operation.
///
/// See also [`Efd::fourier_power_anaysis()`].
///
/// # Panics
/// Panics if the threshold is not in 0..1, or the harmonic is zero.
pub fn fpa_inplace(&mut self, threshold: impl Into<Option<f64>>) {
let lut = self.coeffs.iter().map(|m| m.map(pow2).sum()).collect();
self.set_harmonic(fourier_power_anaysis(lut, threshold.into()));
}
/// Set the harmonic number of the coefficients.
///
/// If the harmonic is greater or equal to the current harmonic, this method
/// does nothing. (like the `truncate` method)
///
/// # Panics
/// Panics if the harmonic is zero.
pub fn set_harmonic(&mut self, harmonic: usize) {
assert!(harmonic > 0, "harmonic must geater than 0");
self.coeffs.truncate(harmonic);
}
/// Force normalize the coefficients.
///
/// If the coefficients are constructed by `*_unnorm` or `*_unchecked`
/// methods, this method will normalize them.
///
/// See also [`Efd::from_curve_harmonic_unnorm()`].
///
/// # Panics
/// Panics if the harmonic is zero.
pub fn normalized(self) -> Self {
let Self { mut coeffs, geo } = self;
let geo = geo * U::norm_coeff(&mut coeffs, None);
Self { coeffs, geo }
}
/// Consume self and return the parts of this type.
///
/// See also [`Efd::from_parts_unchecked()`].
pub fn into_inner(self) -> (Coeffs<D>, GeoVar<Rot<D>, D>) {
(self.coeffs, self.geo)
}
/// Get a reference to the coefficients.
pub fn coeffs(&self) -> &[Kernel<D>] {
&self.coeffs
}
/// Get a view to the specific coefficients. (`0..self.harmonic()`)
pub fn coeff(&self, harmonic: usize) -> &Kernel<D> {
&self.coeffs[harmonic]
}
/// Get an iterator over all the coefficients per harmonic.
pub fn coeffs_iter(&self) -> impl Iterator<Item = &Kernel<D>> {
self.coeffs.iter()
}
/// Get a mutable iterator over all the coefficients per harmonic.
///
/// **Warning: If you want to change the coefficients, the geometric
/// variables will be wrong.**
pub fn coeffs_iter_mut(&mut self) -> impl Iterator<Item = &mut Kernel<D>> {
self.coeffs.iter_mut()
}
/// Get the reference of geometric variables.
pub fn as_geo(&self) -> &GeoVar<Rot<D>, D> {
&self.geo
}
/// Get the mutable reference of geometric variables.
pub fn as_geo_mut(&mut self) -> &mut GeoVar<Rot<D>, D> {
&mut self.geo
}
/// Check if the descibed curve is open.
pub fn is_open(&self) -> bool {
self.coeffs[0].column(1).sum() == 0.
}
/// Get the harmonic number of the coefficients.
#[inline]
pub fn harmonic(&self) -> usize {
self.coeffs.len()
}
/// Check if the coefficients are valid.
///
/// + The harmonic number must be greater than 0.
/// + All the coefficients must be finite number.
///
/// It is only helpful if this object is constructed by
/// [`Efd::from_parts_unchecked()`].
pub fn is_valid(&self) -> bool {
self.harmonic() > 0 && self.coeffs_iter().flatten().all(|x| x.is_finite())
}
/// Calculate the L1 distance between two coefficient set.
///
/// For more distance methods, please see [`Distance`].
pub fn err(&self, rhs: &Self) -> f64 {
self.l1_err(rhs)
}
/// Calculate the distance from a [`PathSig`].
pub fn err_sig(&self, sig: &PathSig<D>) -> f64 {
core::iter::zip(self.recon_norm_by(&sig.t), &sig.curve)
.map(|(a, b)| a.l2_err(b))
.fold(0., f64::max)
}
/// Reverse the order of described curve then return a mutable reference.
pub fn reverse_inplace(&mut self) {
for m in &mut self.coeffs {
let mut m = m.column_mut(1);
m *= -1.;
}
}
/// Consume and return a reversed version of the coefficients.
///
/// This method can avoid mutable require.
pub fn reversed(mut self) -> Self {
self.reverse_inplace();
self
}
/// Reconstruct the described curve.
///
/// If the described curve is open, the time series is `0..PI` instead of
/// `0..TAU`.
pub fn recon(&self, n: usize) -> Vec<[f64; D]> {
let mut curve = self.recon_norm(n);
self.geo.transform_inplace(&mut curve);
curve
}
/// Reconstruct the described curve. (`t=0~TAU`)
///
/// Normalized curve is **without** transformation.
pub fn recon_norm(&self, n: usize) -> Vec<[f64; D]> {
let t = if self.is_open() { PI } else { TAU };
let iter = (0..n).map(|i| i as f64 / (n - 1) as f64 * t);
U::reconstruct(&self.coeffs, iter)
}
/// Reconstruct a described curve in a time series `t`.
/// ```
/// # let curve = efd::tests::CURVE2D;
/// let efd = efd::Efd2::from_curve(curve, false);
/// let sig = efd::PathSig::new(curve, false);
/// let curve_recon = efd.recon_by(sig.as_t());
/// ```
/// See also [`PathSig`].
pub fn recon_by(&self, t: &[f64]) -> Vec<[f64; D]> {
let mut curve = U::reconstruct(&self.coeffs, t.iter().copied());
self.geo.transform_inplace(&mut curve);
curve
}
/// Reconstruct a normalized curve in a time series `t`.
///
/// Normalized curve is **without** transformation.
///
/// See also [`Efd::recon_by()`].
pub fn recon_norm_by(&self, t: &[f64]) -> Vec<[f64; D]> {
U::reconstruct(&self.coeffs, t.iter().copied())
}
}
impl<const D: usize> core::fmt::Debug for Efd<D>
where
U<D>: EfdDim<D>,
{
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
if self.is_valid() {
f.debug_struct(&format!("Efd{D}"))
.field("is_open", &self.is_open())
.field("harmonic", &self.harmonic())
.field("geo", &self.geo)
.field("coeff", &CoeffFmt(&self.coeffs))
.finish()
} else {
f.debug_struct(&format!("Efd{D}"))
.field("is_valid", &false)
.finish()
}
}
}
impl<const D: usize> core::fmt::Debug for PosedEfd<D>
where
U<D>: EfdDim<D>,
{
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
f.debug_struct(&format!("PosedEfd{D}"))
.field("harmonic", &self.harmonic())
.finish()
}
}
struct CoeffFmt<'a, const D: usize>(&'a Coeffs<D>);
impl<const D: usize> core::fmt::Debug for CoeffFmt<'_, D> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
let entries = self.0.iter().map(|c| c.iter().copied().collect::<Vec<_>>());
f.debug_list().entries(entries).finish()
}
}
pub(crate) fn fourier_power_anaysis(lut: Vec<f64>, threshold: Option<f64>) -> usize {
let threshold = threshold.unwrap_or(0.9999);
assert!((0.0..1.0).contains(&threshold), "threshold must in 0..1");
let lut = cumsum(na::Matrix1xX::from_vec(lut));
let target = lut[lut.len() - 1] * threshold;
match lut
.as_slice()
.binary_search_by(|x| x.partial_cmp(&target).unwrap())
{
// Get the nearest harmonic
Ok(h) | Err(h) => h + 1,
}
}