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 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
/* MIT License Copyright (c) 2021 Philipp Schuster Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ //! Module for the struct [`FrequencySpectrum`]. use crate::frequency::{Frequency, FrequencyValue}; use alloc::boxed::Box; use alloc::collections::BTreeMap; use alloc::vec::Vec; use core::cell::{Cell, Ref, RefCell}; /// Describes the type for a function factory that generates a function that can scale/normalize /// the data inside [`FrequencySpectrum`]. /// /// **Complex** means it's not basic. It has nothing to do with complex numbers. /// /// This can archive exactly the same as [`crate::SimpleSpectrumScalingFunction`] /// but is capable of doing more complex logic, i.e. you have access to min, max, /// or median! /// /// This can be used for example to subtract `min` value from all values, /// if `min` is `> 0`. The signature is the following: /// `(min: f32, max: f32, average: f32, median: f32) -> fn(f32) -> f32` /// i.e. you provide a function which generates a function that gets /// applied to each element. The input arguments are automatically calculated /// by [`FrequencySpectrum`]. /// /// The scaling only affects the value/amplitude of the frequency /// but not the frequency itself. pub type ComplexSpectrumScalingFunction = Box<dyn Fn(f32, f32, f32, f32) -> Box<dyn Fn(f32) -> f32>>; /// Convenient wrapper around the processed FFT result which describes each frequency and /// its value/amplitude in the analyzed slice of samples. It only consists of the frequencies /// which were desired, e.g. specified via /// [`crate::limit::FrequencyLimit`] when [`crate::samples_fft_to_spectrum`] was called. #[derive(Debug)] pub struct FrequencySpectrum { /// Raw data. Vector is sorted from lowest /// frequency to highest and data is normalized/scaled /// according to all applied scaling functions. data: RefCell<Vec<(Frequency, FrequencyValue)>>, /// Frequency resolution of the examined samples in Hertz, /// i.e the frequency steps between elements in the vector /// inside field [`data`]. frequency_resolution: f32, /// Average value of frequency value/magnitude/amplitude /// corresponding to data in [`FrequencySpectrum::data`]. average: Cell<FrequencyValue>, /// Median value of frequency value/magnitude/amplitude /// corresponding to data in [`FrequencySpectrum::data`]. median: Cell<FrequencyValue>, /// Pair of (frequency, frequency value/magnitude/amplitude) where /// frequency value is **minimal** inside the spectrum. /// Corresponding to data in [`FrequencySpectrum::data`]. min: Cell<(Frequency, FrequencyValue)>, /// Pair of (frequency, frequency value/magnitude/amplitude) where /// frequency value is **maximum** inside the spectrum. /// Corresponding to data in [`FrequencySpectrum::data`]. max: Cell<(Frequency, FrequencyValue)>, } impl FrequencySpectrum { /// Creates a new object. Calculates several metrics on top of /// the passed vector. /// /// ## Parameters /// * `data` Vector with all ([`Frequency`], [`FrequencyValue`])-tuples /// * `frequency_resolution` Resolution in Hertz. This equals to /// `data[1].0 - data[0].0`. #[inline(always)] pub fn new( data: Vec<(Frequency, FrequencyValue)>, frequency_resolution: f32, ) -> Self { let obj = Self { data: RefCell::new(data), frequency_resolution, // default/placeholder values average: Cell::new(FrequencyValue::from(-1.0)), median: Cell::new(FrequencyValue::from(-1.0)), min: Cell::new(( Frequency::from(-1.0), FrequencyValue::from(-1.0), )), max: Cell::new(( Frequency::from(-1.0), FrequencyValue::from(-1.0), )), }; // IMPORTANT!! obj.calc_statistics(); obj } /// Applies the function generated by `total_scaling_fn` to each element and updates /// `min`, `max`, etc. afterwards accordingly. /// /// ## Parameters /// * `total_scaling_fn` See [`crate::spectrum::SpectrumTotalScaleFunctionFactory`]. #[inline(always)] pub fn apply_complex_scaling_fn(&self, total_scaling_fn: ComplexSpectrumScalingFunction) { let scale_fn = (total_scaling_fn)( // into() => FrequencyValue => f32 self.min.get().1.val(), self.max.get().1.val(), self.average.get().val(), self.median.get().val(), ); { // drop RefMut<> from borrow_mut() before calc_statistics let mut data = self.data.borrow_mut(); for (_fr, fr_val) in data.iter_mut() { *fr_val = (scale_fn)(fr_val.val()).into() } // drop RefMut<> from borrow_mut() before calc_statistics } self.calc_statistics(); } /// Getter for [`FrequencySpectrum::average`]. #[inline(always)] pub fn average(&self) -> FrequencyValue { self.average.get() } /// Getter for [`FrequencySpectrum::median`]. #[inline(always)] pub fn median(&self) -> FrequencyValue { self.median.get() } /// Getter for [`FrequencySpectrum::max`]. #[inline(always)] pub fn max(&self) -> (Frequency, FrequencyValue) { self.max.get() } /// Getter for [`FrequencySpectrum::min`]. #[inline(always)] pub fn min(&self) -> (Frequency, FrequencyValue) { self.min.get() } /// Returns [`FrequencySpectrum::max().1`] - [`FrequencySpectrum::min().1`], /// i.e. the range of the frequency values (not the frequencies itself, /// but their amplitude/value). #[inline(always)] pub fn range(&self) -> FrequencyValue { self.max().1 - self.min().1 } /// Getter for [`FrequencySpectrum::data`]. #[inline(always)] pub fn data(&self) -> Ref<Vec<(Frequency, FrequencyValue)>> { self.data.borrow() } /// Getter for [`FrequencySpectrum::frequency_resolution`]. #[inline(always)] pub fn frequency_resolution(&self) -> f32 { self.frequency_resolution } /// Returns the value of the given frequency from the spectrum either exactly or approximated. /// If `search_fr` is not exactly given in the spectrum, i.e. due to the /// [`self::frequency_resolution`], this function takes the two closest /// neighbors/points (A, B), put a linear function through them and calculates /// the point C in the middle. This is done by using /// [`calculate_point_between_points`]. /// /// ## Panics /// If parameter `search_fr` (frequency) is below the lowest or the maximum /// frequency, this function panics! This is because the user provide /// the min/max frequency when the spectrum is created and knows about it. /// This is similar to an intended "out of bounds"-access. /// /// ## Parameters /// - `search_fr` The frequency of that you want the amplitude/value in the spectrum. /// /// ## Return /// Either exact value of approximated value, determined by [`self::frequency_resolution`]. #[inline(always)] pub fn freq_val_exact(&self, search_fr: f32) -> FrequencyValue { let data = self.data.borrow(); // lowest frequency in the spectrum // TODO use minFrequency() and maxFrequency() let (min_fr, min_fr_val) = data[0]; // highest frequency in the spectrum let (max_fr, max_fr_val) = data[data.len() - 1]; // https://docs.rs/float-cmp/0.8.0/float_cmp/ let equals_min_fr = float_cmp::approx_eq!(f32, min_fr.val(), search_fr, ulps = 3); let equals_max_fr = float_cmp::approx_eq!(f32, max_fr.val(), search_fr, ulps = 3); // Fast return if possible if equals_min_fr { return min_fr_val; } if equals_max_fr { return max_fr_val; } // bounds check if search_fr < min_fr.val() || search_fr > max_fr.val() { panic!("Frequency {}Hz is out of bounds [{}; {}]!", search_fr, min_fr.val(), max_fr.val()); } // We search for Point C (x=search_fr, y=???) between Point A and Point B iteratively. // Point B is always the successor of A. for two_points in data.iter().as_slice().windows(2) { let point_a = two_points[0]; let point_b = two_points[1]; let point_a_x = point_a.0.val(); let point_a_y = point_a.1; let point_b_x = point_b.0.val(); let point_b_y = point_b.1.val(); // check if we are in the correct window; we are in the correct window // iff point_a_x <= search_fr <= point_b_x if search_fr > point_b_x { continue; } return if float_cmp::approx_eq!(f32, point_a_x, search_fr, ulps = 3) { // directly return if possible point_a_y } else { calculate_y_coord_between_points( (point_a_x, point_a_y.val()), (point_b_x, point_b_y), search_fr, ).into() } } panic!("Here be dragons"); } /// Returns the frequency closest to parameter `search_fr` in the spectrum. For example /// if the spectrum looks like this: /// ```text /// Vector: [0] [1] [2] [3] /// Frequency 100 Hz 200 Hz 300 Hz 400 Hz /// Fr Value 0.0 1.0 0.5 0.1 /// ``` /// then `get_frequency_value_closest(320)` will return `(300.0, 0.5)`. /// /// ## Panics /// If parameter `search_fre` (frequency) is below the lowest or the maximum /// frequency, this function panics! /// /// ## Parameters /// - `search_fr` The frequency of that you want the amplitude/value in the spectrum. /// /// ## Return /// Closest matching point in spectrum, determined by [`self::frequency_resolution`]. #[inline(always)] pub fn freq_val_closest(&self, search_fr: f32) -> (Frequency, FrequencyValue) { let data = self.data.borrow(); // lowest frequency in the spectrum // TODO use minFrequency() and maxFrequency() let (min_fr, min_fr_val) = data[0]; // highest frequency in the spectrum let (max_fr, max_fr_val) = data[data.len() - 1]; // https://docs.rs/float-cmp/0.8.0/float_cmp/ let equals_min_fr = float_cmp::approx_eq!(f32, min_fr.val(), search_fr, ulps = 3); let equals_max_fr = float_cmp::approx_eq!(f32, max_fr.val(), search_fr, ulps = 3); // Fast return if possible if equals_min_fr { return (min_fr, min_fr_val); } if equals_max_fr { return (max_fr, max_fr_val); } // bounds check if search_fr < min_fr.val() || search_fr > max_fr.val() { panic!("Frequency {}Hz is out of bounds [{}; {}]!", search_fr, min_fr.val(), max_fr.val()); } for two_points in data.iter().as_slice().windows(2) { let point_a = two_points[0]; let point_b = two_points[1]; let point_a_x = point_a.0; let point_a_y = point_a.1; let point_b_x = point_b.0; let point_b_y = point_b.1; // check if we are in the correct window; we are in the correct window // iff point_a_x <= search_fr <= point_b_x if search_fr > point_b_x.val() { continue; } return if float_cmp::approx_eq!(f32, point_a_x.val(), search_fr, ulps = 3) { // directly return if possible (point_a_x, point_a_y) } else { // absolute difference let delta_to_a = search_fr - point_a_x.val(); // let delta_to_b = point_b_x.val() - search_fr; if delta_to_a / self.frequency_resolution < 0.5 { (point_a_x, point_a_y) } else { (point_b_x, point_b_y) } } } panic!("Here be dragons"); } /// Returns a `BTreeMap`. The key is of type u32. /// (`f32` is not `Ord`, hence we can't use it as key.) You can optionally specify a /// scale function, e.g. multiply all frequencies with 1000 for better /// accuracy when represented as unsigned integer. /// /// ## Parameters /// * `scale_fn` optional scale function, e.g. multiply all frequencies with 1000 for better /// accuracy when represented as unsigned integer. /// /// ## Return /// New `BTreeMap` from frequency to frequency value. #[inline(always)] pub fn to_map(&self, scale_fn: Option<&dyn Fn(f32) -> u32>) -> BTreeMap<u32, f32> { self.data .borrow() .iter() .map(|(fr, fr_val)| (fr.val(), fr_val.val())) .map(|(fr, fr_val)| { ( if let Some(fnc) = scale_fn { (fnc)(fr) } else { fr as u32 }, fr_val, ) }) .collect() } /*/// Returns an iterator over the underlying vector [`data`]. #[inline(always)] pub fn iter(&self) -> Iter<(Frequency, FrequencyValue)> { self.data.borrow().iter() }*/ /// Calculates min, max, median and average of the frequency values/magnitudes/amplitudes. #[inline(always)] fn calc_statistics(&self) { let mut data_sorted = self.data.borrow().clone(); data_sorted.sort_by(|(_l_fr, l_fr_val), (_r_fr, r_fr_val)| { // compare by frequency value, from min to max l_fr_val.cmp(r_fr_val) }); // sum let sum: f32 = data_sorted .iter() .map(|fr_val| fr_val.1.val()) .fold(0.0, |a, b| a + b); let avg = sum / data_sorted.len() as f32; let average: FrequencyValue = avg.into(); let median = { // we assume that data_sorted.length() is always even, because // it must be a power of 2 (for FFT) let a = data_sorted[data_sorted.len() / 2 - 1].1; let b = data_sorted[data_sorted.len() / 2].1; (a + b) / 2.0.into() }; // because we sorted the vector a few lines above // by the value, the following lines are correct let min = data_sorted[0]; let max = data_sorted[data_sorted.len() - 1]; // check that I get the comparison right (and not from max to min) debug_assert!(min.1 <= max.1); self.min.replace(min); self.max.replace(max); self.average.replace(average); self.median.replace(median); } } /*impl FromIterator<(Frequency, FrequencyValue)> for FrequencySpectrum { #[inline(always)] fn from_iter<T: IntoIterator<Item=(Frequency, FrequencyValue)>>(iter: T) -> Self { // 1024 is just a guess: most likely 2048 is a common FFT length, // i.e. 1024 results for the frequency spectrum. let mut vec = Vec::with_capacity(1024); for (fr, val) in iter { vec.push((fr, val)) } FrequencySpectrum::new(vec) } }*/ /// Calculates the y coordinate of Point C between two given points A and B /// if the x-coordinate of C is known. It does that by putting a linear function /// through the two given points. /// /// ## Parameters /// - `(x1, y1)` x and y of point A /// - `(x2, y2)` x and y of point B /// - `x_coord` x coordinate of searched point C /// /// ## Return Value /// y coordinate of searched point C #[inline(always)] fn calculate_y_coord_between_points((x1, y1): (f32, f32), (x2, y2): (f32, f32), x_coord: f32) -> f32 { // e.g. Points (100, 1.0) and (200, 0.0) // y=f(x)=-0.01x + c // 1.0 = f(100) = -0.01x + c // c = 1.0 + 0.01*100 = 2.0 // y=f(180)=-0.01*180 + 2.0 // gradient, anstieg let slope = (y2 - y1)/(x2 - x1); // calculate c in y=f(x)=slope * x + c let c = y1 - slope * x1; slope * x_coord + c } #[cfg(test)] mod tests { use super::*; #[test] fn test_calculate_point_between_points() { assert_eq!( // expected y coordinate 0.5, calculate_y_coord_between_points( (100.0, 1.0), (200.0, 0.0), 150.0, ), "Must calculate middle point between points by laying a linear function through the two points" ); assert!( // https://docs.rs/float-cmp/0.8.0/float_cmp/ float_cmp::approx_eq!( f32, 0.2, calculate_y_coord_between_points( (100.0, 1.0), (200.0, 0.0), 180.0, ), ulps = 3 ), "Must calculate arbitrary point between points by laying a linear function through the two points" ); } #[test] fn test_spectrum_basic() { let spectrum = vec![ (0.0_f32, 5.0_f32), (50.0, 50.0), (100.0, 100.0), (150.0, 150.0), (200.0, 100.0), (250.0, 20.0), (300.0, 0.0), (450.0, 200.0), ]; let spectrum = spectrum .into_iter() .map(|(fr, val)| (fr.into(), val.into())) .collect::<Vec<(Frequency, FrequencyValue)>>(); let spectrum = FrequencySpectrum::new( spectrum, 50.0, ); // test inner vector is ordered { assert_eq!( (0.0.into(), 5.0.into()), spectrum.data()[0], "Vector must be ordered" ); assert_eq!( (50.0.into(), 50.0.into()), spectrum.data()[1], "Vector must be ordered" ); assert_eq!( (100.0.into(), 100.0.into()), spectrum.data()[2], "Vector must be ordered" ); assert_eq!( (150.0.into(), 150.0.into()), spectrum.data()[3], "Vector must be ordered" ); assert_eq!( (200.0.into(), 100.0.into()), spectrum.data()[4], "Vector must be ordered" ); assert_eq!( (250.0.into(), 20.0.into()), spectrum.data()[5], "Vector must be ordered" ); assert_eq!( (300.0.into(), 0.0.into()), spectrum.data()[6], "Vector must be ordered" ); assert_eq!( (450.0.into(), 200.0.into()), spectrum.data()[7], "Vector must be ordered" ); } // test getters { assert_eq!((300.0.into(), 0.0.into()), spectrum.min(), "min() must work"); assert_eq!((450.0.into(), 200.0.into()), spectrum.max(), "max() must work"); assert_eq!(200.0 - 0.0, spectrum.range().val(), "range() must work"); assert_eq!(78.125, spectrum.average().val(), "average() must work"); assert_eq!( (50 + 100) as f32 / 2.0, spectrum.median().val(), "median() must work" ); assert_eq!( 50.0, spectrum.frequency_resolution(), "frequency resolution must be returned" ); } // test get frequency exact { assert_eq!( 5.0, spectrum.freq_val_exact(0.0).val(), ); assert_eq!( 50.0, spectrum.freq_val_exact(50.0).val(), ); assert_eq!( 150.0, spectrum.freq_val_exact(150.0).val(), ); assert_eq!( 100.0, spectrum.freq_val_exact(200.0).val(), ); assert_eq!( 20.0, spectrum.freq_val_exact(250.0).val(), ); assert_eq!( 0.0, spectrum.freq_val_exact(300.0).val(), ); assert_eq!( 100.0, spectrum.freq_val_exact(375.0).val(), ); assert_eq!( 200.0, spectrum.freq_val_exact(450.0).val(), ); } // test get frequency closest { assert_eq!( (0.0.into(), 5.0.into()), spectrum.freq_val_closest(0.0), ); assert_eq!( (50.0.into(), 50.0.into()), spectrum.freq_val_closest(50.0), ); assert_eq!( (450.0.into(), 200.0.into()), spectrum.freq_val_closest(450.0), ); assert_eq!( (450.0.into(), 200.0.into()), spectrum.freq_val_closest(448.0), ); assert_eq!( (450.0.into(), 200.0.into()), spectrum.freq_val_closest(400.0), ); assert_eq!( (50.0.into(), 50.0.into()), spectrum.freq_val_closest(47.3), ); assert_eq!( (50.0.into(), 50.0.into()), spectrum.freq_val_closest(51.3), ); } } #[test] #[should_panic] fn test_spectrum_get_frequency_value_exact_panic_below_min() { let spectrum_vector = vec![ (0.0_f32, 5.0_f32), (450.0, 200.0), ]; let spectrum = spectrum_vector .into_iter() .map(|(fr, val)| (fr.into(), val.into())) .collect::<Vec<(Frequency, FrequencyValue)>>(); let spectrum = FrequencySpectrum::new( spectrum, 50.0, ); spectrum.freq_val_exact(-1.0).val(); } #[test] #[should_panic] fn test_spectrum_get_frequency_value_exact_panic_below_max() { let spectrum_vector = vec![ (0.0_f32, 5.0_f32), (450.0, 200.0), ]; let spectrum = spectrum_vector .into_iter() .map(|(fr, val)| (fr.into(), val.into())) .collect::<Vec<(Frequency, FrequencyValue)>>(); let spectrum = FrequencySpectrum::new( spectrum, 50.0, ); spectrum.freq_val_exact(451.0).val(); } #[test] #[should_panic] fn test_spectrum_get_frequency_value_closest_panic_below_min() { let spectrum_vector = vec![ (0.0_f32, 5.0_f32), (450.0, 200.0), ]; let spectrum = spectrum_vector .into_iter() .map(|(fr, val)| (fr.into(), val.into())) .collect::<Vec<(Frequency, FrequencyValue)>>(); let spectrum = FrequencySpectrum::new( spectrum, 50.0, ); spectrum.freq_val_closest(-1.0); } #[test] #[should_panic] fn test_spectrum_get_frequency_value_closest_panic_below_max() { let spectrum_vector = vec![ (0.0_f32, 5.0_f32), (450.0, 200.0), ]; let spectrum = spectrum_vector .into_iter() .map(|(fr, val)| (fr.into(), val.into())) .collect::<Vec<(Frequency, FrequencyValue)>>(); let spectrum = FrequencySpectrum::new( spectrum, 50.0, ); spectrum.freq_val_closest(451.0); } }